Skip to main content

List Coins

The coins your workspace offers, by ticker: what each one is called, how many decimals an amount of it carries, and the chain it settles on. A coin the workspace has turned off is left out.

Replaces GET /api/v2/coins. Any key can call it, workspace-scoped or account-scoped: the catalogue is the same for every account.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

GET

/v3/coins

There are no parameters. The whole catalogue is returned at once: this list is not paginated.

Response Sample​

{
"data": [
{
"coin": "BTC",
"name": "Bitcoin",
"kind": "crypto",
"decimals": 8,
"network": "bitcoin"
},
{
"coin": "ETH",
"name": "Ethereum",
"kind": "crypto",
"decimals": 18,
"network": "ethereum"
},
{
"coin": "USD",
"name": "US Dollar",
"kind": "fiat",
"decimals": 2
}
]
}

Response Schema​

FieldTypeDescription
dataarrayThe coins the workspace offers, by ticker.
data[].coinstringThe ticker, in upper case (e.g., BTC, USD). Use it wherever a coin is asked for.
data[].namestringDisplay name (e.g., Bitcoin).
data[].kindstringcrypto or fiat.
data[].decimalsintDecimal places an amount of the coin is counted in (e.g., 2 for USD, 8 for BTC, 18 for ETH).
data[].networkstringThe chain the coin settles on (e.g., bitcoin, ethereum). Absent for fiat, and for a coin the catalogue names no chain for (XRP).

Coming from v2​

v2 fieldv3 field
id, symbolcoin
typekind
precisiondecimals
name, networkunchanged

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!