Geocoding API endpoint
Use Crawlora's Geocoding Search API to extract supported public Geocoding data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/geocoding/searchReturns typed Nominatim JSONv2 forward geocoding results. Use either q or structured fields, not both. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and AI-agent workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| q | string | No | Free-text search query | ||
| street | string | No | Structured street or house number | ||
| city | string | No | Structured city | ||
| county | string | No | Structured county | ||
| state | string | No | Structured state | ||
| country | string | No | Structured country | ||
| postalcode | string | No | Structured postal code | ||
| limit | integer | No | 10 and clamps to 20 | Maximum results, defaults to 10 and clamps to 20 | |
| countrycodes | string | No | Comma-separated ISO 3166-1 alpha-2 country filters | ||
| accept_language | string | No | Preferred result language, forwarded to Nominatim | ||
| addressdetails | boolean | No | true | Include address details, defaults to true | |
| extratags | boolean | No | Include OSM extra tags | ||
| namedetails | boolean | No | Include multilingual name details | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/geocoding/search?q=coffee&country=us&limit=10&addressdetails=true&extratags=true&namedetails=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Example response: ```json {"code":200,"msg":"OK","data":{"query":"Empire State Building","results":[{"place_id":358220252,"osm_type":"way","osm_id":34633854,"lat":"40.7484421","lon":"-73.9856589","category":"office","type":"yes","place_rank":30,"importance":0.5803438355141769,"addresstype":"office","name":"Empire State Building","display_name":"Empire State Building, 350, 5th Avenue, New York, United States","address":{"office":"Empire State Building","house_number":"350","road":"5th Avenue","city":"New York","state":"New York","postcode":"10118","country":"United States","country_code":"us"},"boundingbox":["40.7479255","40.7489585","-73.9865012","-73.9848166"]}]}} ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"query": "Empire State Building",
"results": [
{
"place_id": 358220252,
"osm_type": "way",
"osm_id": 34633854,
"lat": "40.7484421",
"lon": "-73.9856589",
"category": "office",
"type": "yes",
"place_rank": 30,
"importance": 0.5803438355141769,
"addresstype": "office",
"name": "Empire State Building",
"display_name": "Empire State Building, 350, 5th Avenue, New York, United States",
"address": {
"office": "Empire State Building",
"house_number": "350",
"road": "5th Avenue",
"city": "New York",
"state": "New York",
"postcode": "10118",
"country": "United States",
"country_code": "us"
},
"boundingbox": [
"40.7479255",
"40.7489585",
"-73.9865012",
"-73.9848166"
]
}
]
}
}Request schema
No body schema
Response schema
#/definitions/geocoding.searchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | geocoding.SearchResponse | No | ||||
| data.query | string | No | Empire State Building | |||
| data.results | array | No | ||||
| data.results[].address | geocoding.Address | No | ||||
| data.results[].address.ISO3166-2-lvl4 | string | No | US-NY | |||
| data.results[].address.ISO3166-2-lvl6 | string | No | ||||
| data.results[].address.city | string | No | New York | |||
| data.results[].address.country | string | No | United States | |||
| data.results[].address.country_code | string | No | us | |||
| data.results[].address.county | string | No | New York County | |||
| data.results[].address.house_number | string | No | 350 | |||
| data.results[].address.neighbourhood | string | No | Koreatown | |||
| data.results[].address.office | string | No | Empire State Building | |||
| data.results[].address.postcode | string | No | 10118 | |||
| data.results[].address.road | string | No | 5th Avenue | |||
| data.results[].address.state | string | No | New York | |||
| data.results[].address.state_district | string | No | ||||
| data.results[].address.suburb | string | No | Manhattan | |||
| data.results[].address.town | string | No | ||||
| data.results[].address.village | string | No | ||||
| data.results[].addresstype | string | No | office | |||
| data.results[].boundingbox | array | No | 40.7479255,40.7489585,-73.9865012,-73.9848166 | |||
| data.results[].category | string | No | office | |||
| data.results[].display_name | string | No | Empire State Building, 350, 5th Avenue, New York, United States | |||
| data.results[].extratags | object | No | ||||
| data.results[].importance | number | No | 0.5803438355141769 | |||
| data.results[].lat | string | No | 40.7484421 | |||
| data.results[].licence | string | No | Data © OpenStreetMap contributors, ODbL 1.0. http://osm.org/copyright | |||
| data.results[].lon | string | No | -73.9856589 | |||
| data.results[].name | string | No | Empire State Building | |||
| data.results[].namedetails | object | No | ||||
| data.results[].osm_id | integer | No | 34633854 | |||
| data.results[].osm_type | string | No | way | |||
| data.results[].place_id | integer | No | 358220252 | |||
| data.results[].place_rank | integer | No | 30 | |||
| data.results[].type | string | No | yes | |||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/geocoding/search?q=coffee&country=us&limit=10&addressdetails=true&extratags=true&namedetails=true" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms