Tokens

The tokens (assets) supported for travel-rule transfers.

List Tokens

get

Return the list of tokens supported by the Ospree Travel Rule module, including the Digital Token Identifier (DTI), symbol, and associated blockchain network, to help select the correct token for a transfer.

dti is the stable identifier for a token. Every token listed here is accepted by POST /transfers when the transfer identifies its asset by dti, and every token that path accepts is listed here. The same chain and symbol can name several distinct assets (two USD Coins on arbitrum-one, for instance): name and contract tell them apart, and the chain+symbol form of POST /transfers cannot resolve such a pair — send those by dti.

The chain, symbol and dti filters all match exactly. Filtering by dti returns the single asset that identifier names, which is the only way to address one asset of a pair that shares a chain and symbol.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

chainstring · nullableOptional

Filter by chain (exact match)

symbolstring · nullableOptional

Filter by symbol (exact match)

dtistring · nullableOptional

Filter by Digital Token Identifier (exact match, case-insensitive)

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 100OptionalDefault: 50

Responses

200

A page of sendable assets, as the DTI registry records them.

application/json

statusstringOptionalDefault: success

401

Unauthorized

application/json

422

Unprocessable Entity - Validation Error

application/json

500

Internal Server Error

application/json

get/api/v2/travelrule/tokens/

GET /api/v2/travelrule/tokens/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "items": [
      {
        "chain": "bitcoin",
        "symbol": "BTC",
        "name": "Bitcoin",
        "dti": "4H95J0R2X",
        "decimals": 8,
        "dti_type": 1
      },
      {
        "chain": "arbitrum-one",
        "symbol": "USDC",
        "name": "USD Coin",
        "dti": "X9J2T7K4M",
        "contract": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
        "decimals": 6,
        "dti_type": 2
      }
    ],
    "total": 2,
    "page": 1,
    "size": 50,
    "pages": 1
  }
}