Back to the OpenAPI page
API Reference

API Title

API Description

Parameter count: 0

Download OpenAPI file

About OpenAPI files: OpenAPI files are widely used in tools like Postman, Swagger UI, and various code generators to automate API documentation, testing, and client SDK creation, streamlining the development workflow.

Endpoints

All routes exposed by this API. POST recommended

Parameters

Below is a list of all available parameters for this API.

Parameter Location Type

Outputs

Below is a list of all available outputs for this API.

Response lifecycle

The path every request takes before becoming the response shown on the right.

1 · Request received
The endpoint is called with the required parameters — via query string or JSON body — together with valid authentication credentials.
2 · Validation & processing
Inputs are validated server-side and the core calculation runs. Invalid input short-circuits with a descriptive error status.
3 · JSON response returned
A 200 OK payload delivers the properties listed below, typed exactly as shown in the table.
Property Type

All properties are included in every successful response unless stated otherwise in the endpoint description.

Example response

Shape of a successful 200 JSON response — values show each property's data type.

Status200 OK
FormatJSON
EncodingUTF-8