Location - Coordinates
The API returns all people based on location in JSON format.
In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API ).
The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS.
API endpoints
- https://api.bisnode.fi/people/info/v2/location - production environment
- https://api-test.bisnode.fi/people/info/v2/location - test environment
API response
| Data element |
Description |
|---|---|
| BisnodeId | The unique person id. e.g. FI2101002069198 |
| x | Longitude. e.g. 24.955964 |
| y | Latitude. e.g. 60.194662 |
API request parameters
| Parameter | Description | |
|---|---|---|
| x | Longitude value. | X |
| y | Latitude value. | X |
| radius | Radius max value is 5000. | X |
| X = Mandatory | ||
https://api-test.bisnode.fi/people/info/v2/location?x={x}&y={y}&radius={radius}
cURL request example
curl 'https://api-test.bisnode.fi/people/info/v2/location?x=24.956794&y=60.194811&radius=50' -H 'x-api-key: 1234567890ABC'
API request and response example
GET https://api-test.bisnode.fi/people/info/v2/location?x=24.956794&y=60.194811&radius=100
Successful request and the API return results in JSON format.
{
"coordinateSystem": "Wgs84",
"count": 105,
"errorMessage": null,
"hits": [
{
"bisnodeId": "FI2101002012316",
"x": 24.955964,
"y": 60.194662
},
{
"bisnodeId": "FI2101002069198",
"x": 24.955964,
"y": 60.194662
},
{
"bisnodeId": "FI2101002136868",
"x": 24.957108,
"y": 60.194824
},
{
"bisnodeId": "FI2101002244148",
"x": 24.957108,
"y": 60.194824
},
{
"bisnodeId": "FI2101010876892",
"x": 24.956936,
"y": 60.194974
}
]
}