https://github.com/stve/domainr

Ruby wrapper for the Domainr API
https://github.com/stve/domainr

Last synced: 23 days ago
JSON representation

Ruby wrapper for the Domainr API

• Host: GitHub
• URL: https://github.com/stve/domainr
• Owner: stve
• License: mit
• Created: 2010-07-07T05:09:35.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2016-02-29T14:58:51.000Z (over 8 years ago)
• Last Synced: 2024-04-25T11:03:14.595Z (7 months ago)
• Language: Ruby
• Homepage:
• Size: 29.3 KB
• Stars: 10
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# domainr

Ruby wrapper for the [Domainr API](http://domainr.build/).

## Installation

    gem install domainr

## Usage

Instantiate a new client:

    client = Domainr::Client.new(mashape_key: 'abcdefghijklmnopqrstuvwxyz')

If you are using Domainr's high volume API endpoints, you can pass a `client_id` and `endpoint` instead:

    client = Domainr::Client.new(client_id: '123456789', endpoint: 'https://api.domainr.com')

Once configured, you can use the `Domainr::Client` to retrieve information about a domain:

    client.status('google.com')

You can also search Domainr based on a search term:

    client.search('twitter')

## Documentation

[http://rdoc.info/gems/domainr][documentation]

[documentation]: http://rdoc.info/gems/domainr}}

## Contributing

Pull requests welcome: fork, make a topic branch, commit (squash when possible) *with tests* and I'll happily consider.

## Copyright

Copyright (c) 2016 Steve Agalloco. See [LICENSE](LICENSE.md) for detail