WellPack API - v1 (1.0.0)

This API lets you analyze areas.

The creation of new areas consumes credits.

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.wellpack.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 analyze areas: 1 call = 1 area = 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 areas, 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.

Here's the workflow when you create areas:

• Check authentication
• Check parameters validity
• Compute the projected cost: 1 credit, except for the free input
• Check that you have enough credits
• If it's a dry run, stop here
• Consume projected cost
• Perform computation
• If the computation could not be performed on an area and returns an error, this call is refunded

The endpoint /area_analysis lets you analyze a single new area. This endpoint is asynchronous; when submitting your inputs, the API immediately returns an ID. You can then query the API with this ID to check the analysis processing state and retrieve the output when done.

MY_ID = requests.post(
    'https://api.wellpack.seiki.co/v1/area_analysis',
    headers = {'key': MY_API_KEY},
    json = {
            "period_start": "2024-12-01",
            "period_end": "2024-12-31",
            "method": {
                "include_or_exclude_buffer": None,
                "limit_pop": 0.8
            },
            "target": {
                "trip_purpose": None,
                "modes": [
                    "VEHICULES", "MODES_DOUX"
                ],
                "frequency_min": 10,
                "frequency_max": 12,
                "genders": None,
                "ages": ["20-24", "25-29", "30-34"],
                "socio_professional_categories": [
                    "CSP_PLUS"
                ]
            },
            "geometries": [
                {
                    "coordinates": [
                        [
                            [2.313427004839639, 48.877268699116286],
                            [2.3134507995291074, 48.87707178022791],
                            [2.3147852850287336, 48.877121336047594],
                            [2.3147733876846246, 48.87731564655172],
                            [2.313427004839639, 48.877268699116286]
                        ]
                    ],
                    "type": "Polygon"
                }
            ]
        }
).json()["id"]

To retrieve the state and/or output of your id, you can use the following code:

requests.get(
    'https://api.wellpack.seiki.co/v1/area_analysis/' + MY_ID,
    headers = {'key': MY_API_KEY}
)

The output contains all information on the area, including the generated ID and its data.

To wait until a job is done, you can use the following code:

import time
import requests

status_code = 202

while status_code == 202:
    time.sleep(5)  # Wait 5 seconds
    response = requests.get(
        'https://api.wellpack.seiki.co/v1/area_analysis/' + MY_ID,
        headers = {'key': MY_API_KEY}
    )
    status_code = response.status_code

print(response.json())

The results of the area analysis remain available for 48 hours after 'the post', after this period it will no longer be possible to retrieve the data.