Token Metadata OpenAPI Reference

GET /registry/metadata/v1/info

Get information about the registry. The response includes the standards supported by the registry.

Example request:

GET /registry/metadata/v1/info HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK –

    ok

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "adminId": "string",
    "supportedApis": {}
}

  • 404 Not Found –

    not found

    Example response:

    HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "error": "string"
}

  • 500 Internal Server Error –

    Internal server error

    Example response:

    HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "error": "string"
}

GET /registry/metadata/v1/instruments

List all instruments managed by this instrument admin.

Query Parameters:

  • pageSize (integer) – Number of instruments per page.

  • pageToken (string) – The nextPageToken received from the response for the previous page.

Example request:

GET /registry/metadata/v1/instruments HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK –

    ok

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "instruments": [
        {
            "id": "string",
            "name": "string",
            "symbol": "string",
            "totalSupply": "string",
            "totalSupplyAsOf": "2025-08-21T13:48:50.766699",
            "decimals": 1,
            "supportedApis": {}
        }
    ],
    "nextPageToken": "string"
}

  • 404 Not Found –

    not found

    Example response:

    HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "error": "string"
}

  • 500 Internal Server Error –

    Internal server error

    Example response:

    HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "error": "string"
}

GET /registry/metadata/v1/instruments/{instrumentId}

Retrieve an instrument’s metadata.

Parameters:

  • instrumentId (string)

Example request:

GET /registry/metadata/v1/instruments/{instrumentId} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK –

    ok

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "string",
    "name": "string",
    "symbol": "string",
    "totalSupply": "string",
    "totalSupplyAsOf": "2025-08-21T13:48:50.766699",
    "decimals": 1,
    "supportedApis": {}
}

  • 404 Not Found –

    not found

    Example response:

    HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "error": "string"
}

  • 500 Internal Server Error –

    Internal server error

    Example response:

    HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "error": "string"
}

Comments