Tokens

Get List of Tokens

• Method: GET

• Endpoint: /api/v1/crypto/tokens

• Headers:

  • Cookie: The session cookie value.

  • csrf_token: The CSRF token obtained after login.

• Query:

  • limit: (positive integer) Cannot be empty, must be a positive integer, with a maximum value as defined in app configuration.

  • offset: (integer) Cannot be empty, must be an integer with a minimum value of 0. Default value is 0 if not provided.

  • symbols[]: (array of strings) Each element must not be null, not empty, and must be a string.

  • names[]: (array of strings) Each element must not be null, not empty, and must be a string.

  • itins[]: (array of strings) Each element must not be null, not empty, and must be a string.

Description:

The /api/v1/crypto/tokens endpoint is a GET request designed to retrieve a list of cryptocurrency tokens from a database. It supports various query parameters to filter the results, such as limit for controlling the number of records returned, offset for pagination purposes, and arrays of symbols, names, and itins for filtering based on specific token identifiers, names, or International Token Identification Numbers (ITINs), respectively. The response includes detailed information about each token, such as its symbol, name, ITIN, description, and image URL, along with metadata about the query, including the number of records fetched and the total count of records matching the query criteria.

Example with curl:

curl -X GET "http://example.com/api/v1/crypto/tokens?limit=10&offset=0&symbols[]=BTC&names[]=Bitcoin&itins[]=DXVP-YDQC-3" \
     -H "Cookie: session_cookie_value"  \
     -H "csrf_token: your_csrf_token_here"

Example Response Payload:

{
    "data": [
        {
            "id": 6,
            "symbol": "BTC",
            "name": null,
            "itin": "DXVP-YDQC-3",
            "description": null,
            "imageUrl": null,
            "createdAt": "2024-02-09T00:09:06.725Z",
            "updatedAt": "2024-02-16T09:57:11.997Z"
        }
    ],
    "meta": {
        "fetchCount": 1,
        "totalCount": 1
    },
    "status": 1
}

Get Token

• Method: GET

• Endpoint: /api/v1/crypto/tokens/:id

• Headers:

  • Cookie: The session cookie value.

  • csrf_token: The CSRF token obtained after login.

• Parameters:

  • id: (integer) Token identifier in the database.

Description:

The /api/v1/crypto/tokens/:id endpoint facilitates the retrieval of detailed information about a specific cryptocurrency token, identified by its unique id in the database. This GET request is essential for accessing comprehensive data on a single token, including its symbol, name, International Token Identification Number (ITIN), description, image URL, and the timestamps of its creation and last update in the system.

Example with curl:

curl -X GET "http://example.com/api/v1/crypto/tokens/2" \
     -H "Cookie: session_cookie_value"  \
     -H "csrf_token: your_csrf_token_here"

Example Response Payload:

{
    "data": {
        "id": 2,
        "symbol": "kUSD",
        "name": "Kolibri USD",
        "itin": null,
        "description": null,
        "imageUrl": null,
        "createdAt": "2024-02-08T16:07:28.524Z",
        "updatedAt": "2024-02-08T16:07:28.524Z"
    },
    "status": 1
}