NYCGeoClient

A ruby gem for the NYC GeoClient API - https://api-portal.nyc.gov/docs/services/geoclient/operations/geoclient

Installation

Add this line to your application's Gemfile:

gem 'nyc_geo_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nyc_geo_client

NOTE: You will need to register an application with the NYC API Portal, and make sure that you check off access to the Geoclient API for the application. Take note of the Application's subscription key.

API Usage Examples

require "rubygems"
require "nyc_geo_client"

client = NYCGeoClient::Client.new(subscription_key: 'KEY')

# get block and property level information about an address
client.address(house_number: '13', street: 'crosby', borough: 'manhattan')

# property level information about a tax lot
client.bbl(borough: 'manhattan', block: '00233', lot: '0004')

# get property level information about a building
client.bin(bin: '1003041')

# get information about a segment defined by an on street between two cross-streets
client.blockface(
    on_street: '34 st',
    cross_street_one: 'fifth ave',
    cross_street_two: 'sixth ave',
    borough: 'manhattan'
)

# get information about a point defined by two cross streets
client.intersection(
    cross_street_one: '34 st',
    cross_street_two: 'fifth ave',
    borough: 'manhattan'
)

# get address information using a well-known place name
client.place(name: 'empire state building', borough: 'manhattan')

For more information about the data returned by every method please check the specs folder

Configuration

Because NYCGeoClient gem is based on Faraday, it supports the following adapters:

Net::HTTP (default)
Excon
Typhoeus
Patron
EventMachine

Beside the adapter, you can change the following properties:

endpoint
format
user_agent
proxy
debug

For instance:

require 'typhoeus/adapters/faraday' # You will need the typhoeus gem

client = NYCGeoClient.client(adapter: :typhoeus, user_agent: "foobar v1", debug: true, app_id: 'foo', app_key: 'bar')
client.address(house_number: '13', street: 'crosby', borough: 'manhattan')

Ruby versions supported

Check the .travis.yml to see the current supported ruby versions.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

nyc_geo_client