Request format .

All requests made to the API use the base URL:<endpoint>

Data formats.

In addition to HTTP requests, many API operations include the exchange of data in the request or response body. This data must be encoded in JavaScript Object Notation (JSON).

Required header

Content-Type: application/json


The API supports basic authorization.

Required header

Authorization: Basic <base64-encoded credentials>

Your username and password can be created and managed via the web panel

Sample http request.

GET /accounts HTTP/1.0
Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Success response

HTTP/1.0 200 OK
Date: Tue, 01 Jan 2019 00:00:00 GMT
Server: nginx/1.14.0 (Ubuntu)
Content-Length: 713
Connection: close
Content-Type: application/json; charset=UTF-8

Response body

    "result": "success",
    "status": 200,
    "meta": {
        "count": 2,
        "limit": 1000,
        "order": "desc",
        "last_id": 7
    "data": [
            "id": 8,
            "created_at": "2021-03-08T11:16:25.000000Z",
            "updated_at": "2021-03-08T11:16:25.000000Z",
            "url": ""
        .....more data.....

Stay in the loop..

Sign up to our newsletter to keep up-to-date.