numlookupapi

numlookupapi-ruby

numlookupapi-ruby is the official Ruby Wrapper around the numlookupapi API.

Installation

Add this line to your application's Gemfile:

gem 'numlookupapi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install numlookupapi

Configuration

You will need your apikey to use numlookupapi, you can get one https://app.numlookupapi.com/register.

Create an instance and pass your api key like here:

numlookup = numlookupapi::Endpoints.new(:apikey => 'APIKEY')

Usage & Endpoints

Use the instance to call the endpoints

Status

Returns your current quota

numlookup.status()

Info

Checks the provided ip address (both v4 & v6 formats) and returns all available information.

numlookup.info(ip, language)

Parameter	Data type	Mandatory	Description
ip	string, Path Parameter	yes	The ip address you want to query
language	string	no	An ISO Alpha 2 Language Code for localising the ip data

You can find further information on https://numlookupapi.com/docs/

Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/numlookupapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the numlookupapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.