Geo API (1.0.0)
Download OpenAPI specification:Download
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
[- {
- "name": "string",
- "iso": "string",
- "iso3": "string",
- "enabled": "string",
- "units": {
- "distance": "string",
- "weight": "string",
- "capacity": "string",
- "temperature": "string"
}, - "currency": "string",
- "callingCode": "string",
- "zoneDescriptor": "string",
- "locale": "string",
- "continent": "string"
}
]Get Location by What 3 Words
Get Location by What 3 Words
Authorizations:
jwt
query Parameters
| query | string Free text search field for querying |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}Get Location by Address Id
Get Location by Address Id
Authorizations:
jwt
query Parameters
| id required | string Id of the address to get details for |
| source | string Source of the address search result |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}Search addresses
Search for addresses and address containers
Authorizations:
jwt
query Parameters
| query | string Free text search field for querying |
| id | string |
| countryISO | string Filter by country |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "id": "string",
- "type": "string",
- "text": "string",
- "description": "string",
- "source": "loqate"
}Get Location by Coordinates
Get Location by Coordinates
Authorizations:
jwt
query Parameters
| lat required | number Latitude |
| lon required | number Longitude |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
[- {
- "name": "string",
- "iso": "string",
- "iso3": "string",
- "enabled": "string",
- "units": {
- "distance": "string",
- "weight": "string",
- "capacity": "string",
- "temperature": "string"
}, - "currency": "string",
- "callingCode": "string",
- "zoneDescriptor": "string",
- "locale": "string",
- "continent": "string"
}
]Get Location by What 3 Words
Get Location by What 3 Words
Authorizations:
jwt
query Parameters
| query | string Free text search field for querying |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}Get Location by Address Id
Get Location by Address Id
Authorizations:
jwt
query Parameters
| id required | string Id of the address to get details for |
| source | string Source of the address search result |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}Search addresses
Search for addresses and address containers
Authorizations:
jwt
query Parameters
| query | string Free text search field for querying |
| id | string |
| countryISO | string Filter by country |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "id": "string",
- "type": "string",
- "text": "string",
- "description": "string",
- "source": "loqate"
}Get Location by Coordinates
Get Location by Coordinates
Authorizations:
jwt
query Parameters
| lat required | number Latitude |
| lon required | number Longitude |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
- 500
Content type
application/json
{- "what3words": "string",
- "address": {
- "name": "string",
- "line1": "string",
- "line2": "string",
- "line3": "string",
- "city": "string",
- "region": "string",
- "postcode": "string",
- "countryName": "string",
- "countryISO": "string"
}, - "coordinates": {
- "lat": 0,
- "lon": 0
}
}