All of the following endpoints are intended for use by remote servers, such as those powered by TextIt.
Sending a GET to this URL will return information about a NYC street address.
The GET requires the following querystring arguments:
text is the NYC street address to obtain information on, e.g. 654 park place, brooklyn. It should not contain an apartment number.
If an error occurs, the JSON response will contain one of the following errorCode properties:
NOT_IMPLEMENTED means that the server isn't configured to support this endpoint.INVALID_TEXT means that the text querystring argument wasn't provided.GEOCODING_UNAVAILABLE means that an error occurred when attempting to geocode the address.
If successful, a HTTP 200 will be returned, and the JSON response will contain a
result property. It will be null if no information could
be found about the given address (i.e., the address is probably invalid).
Otherwise, it will be an object with the following keys:
predicted_housing_type will be either null
(if we couldn't predict the address' housing type) or one of the following strings:
NYCHA, RENT_STABILIZED, MARKET_RATE.
postalcode is the ZIP code, e.g. "11201". Note that in some rare cases it can be null.name is the street number and name, e.g. "666 FIFTH AVENUE".street is the street name, e.g. "FIFTH AVENUE".borough is the borough, e.g. "Manhattan".label is the full address, e.g. "666 FIFTH AVENUE, Manhattan, New York, NY, USA".pad_bbl is the borough, block, lot number of the address, e.g. "3002920026".The form below can be used to experiment with the API.