api.nettoolkit.com.curl "https://api.nettoolkit.com/v1/geo/geocodes?address=790+E+Duane+Ave,+Sunnyvale,+CA+94085" \
-H "X-NTK-KEY: $YOUR_KEY_HERE"API keys can be passed in as a header or embedded directly into the query string.
curl "https://api.nettoolkit.com/v1/resources" \
-H "X-NTK-KEY: $YOUR_KEY_HERE"curl "https://api.nettoolkit.com/v1/resources?key=$YOUR_KEY_HERE"You can view your API keys on your account home page, or get a free key for testing. Test keys are good for 1000 requests per day.
The web API returns RESTful responses, including a standard HTTP status code and the requested resource or an error. If an error occurs, you can expect to receive a more detailed error code and a message as part of the response.
JSON responses will always have a standard format called a JSON packet.
{
"code": 1000,
"message": "Something or another",
"results": []
}
| Key | Type | Description |
|---|---|---|
| code | number | Numeric status code; see full list above |
| message | string | (Optional) More detailed explanation |
| query | object | (Optional) Query as understood by the server |
| results | array | List of results for successful requests |
{
"code": 1000,
"query": {
"address_query": "790 E Duane Ave, Sunnyvale, CA 94085"
},
"results": [
{
"address": "790 Duane Av E, Sunnyvale, CA, 94085",
"latitude": 37.3865321,
"longitude": -122.01121455,
"house_number": "790",
"street_name": "Duane",
"street_type": "Av",
"city": "Sunnyvale",
"state": "California",
"state_code": "CA",
"postal_code": "94085",
"precision": "rooftop",
"provider": "Openaddresses",
"provider_geocode_time": "133",
"ntk_geocode_time": "192"
}
]
}
{
"code": 7002,
"message": "Missing parameter: address",
"results": []
}
| Code | Value | HTTP Status | Description |
|---|---|---|---|
| 1000 | OK | 200 | No problems here |
| 1001 | UNDERSTOOD | 200 | Request understood, but no content returned |
| 2000 | INTERNAL_ERROR | 500 | Something has gone wrong on our end |
| 2001 | UNKNOWN_ERROR | 500 | Something we've never seen has gone wrong |
| 2002 | CONNECTION_TIMEOUT | 408 | Connection to external service timed out |
| 2003 | SERVICE_TIMEOUT | 408 | Connection to internal service timed out |
| 2004 | GEOCODE_SERVER_BUSY | 503 | Geocoding server is unavailable |
| 2005 | SERVICE_UNAVAILABLE | 503 | Service is temporarily unavailable |
| 3000 | NOT_PERMITTED | 403 | Request not permitted |
| 3001 | INSUFFICIENT_CREDITS | 400 | Not enough credits to complete request |
| 3002 | INVALID_CREDENTIALS | 401 | Invalid key found |
| 3003 | OVER_QUOTA | 403 | Too many requests! |
| 3004 | ACCOUNT_DATABASE_REQUIRED | 403 | Resource requires account database (coming soon) |
| 4000 | BAD_REQUEST | 400 | Invalid request |
| 4001 | INVALID_PARAMETER | 400 | Invalid parameter for request found |
| 4002 | MISSING_PARAMETER | 400 | Required parameter for request not found |
| 5000 | NOT_FOUND | 404 | No results for request |
| 5001 | RESOURCE_DEPENDENCY_ERROR | 409 | Something else depends on this resource |
| 5002 | CONFLICT | 409 | Resource conflict found |
| 5003 | RESOURCE_EXPIRED | 404 | Resource has expired |
| 5500 | UNKNOWN_ROUTE | 404 | No matching route for request |