Seiki API - v1 (1.2.0)

This API lets you analyse your POIs.

To call this API you need an API key provided by Seiki. The API key is provided in every HTTP call in the key header.

Here is an example in Python :

requests.get(
    'https://api.smart4cast.seiki.co/v1/account/credits',
    headers = {'key': MY_API_KEY}
    )

In case of failed authentication, the API returns the following status codes :

• 401 : No API key was provided
• 403 : The provided API key is not authorized to access this API

To use this API, you need credits in order to anlyse POI : 1 POI = 1 credit

To retrieve your amount of credits, you can call the endpoint /account/credits

In case of insufficient credits, the API returns a status code 402.

For the endpoints that analyse POI, the optional boolean parameter dry_run can be provided, which allows you to check authentication and parameters validity at no cost. It also allows you to retrieve what would be the cost of the computation.

The endpoint /poi lets you create a single new POI. This endpoint is synchronous, which means that your client will wait for the API to answer. You can either create a POI by its latitude / longitude, or by its address :

requests.post(
    'https://api.smart4cast.seiki.co/v1/poi',
    headers = { 'key': MY_API_KEY },
    json = { 'lat': 48.8751, 'lng': 2.3074 }
    ).json()

requests.post(
    'https://api.smart4cast.seiki.co/v1/poi',
    headers = { 'key': MY_API_KEY },
    json = { 'address': '178 bd Haussmann Paris' }
    ).json()

The output contains all information on the POI