Documentation/Canton SDK/Token Standard APIs Token Metadata OpenAPI ReferenceView on Canton SDK ↗
Canton SDK/Token Standard APIs Token Metadata OpenAPI Reference

Token Metadata OpenAPI Reference

Deprecated

This Splice documentation site is deprecated. Use the current Canton Network docs.

Open current docs

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": "2026-06-04T17:18:55.929896",
            "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": "2026-06-04T17:18:55.929896",
    "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