Get currency | Taurus Developer Hub

curl -G https://your-protect-instance.example.com/api/rest/v1/currency \
     -H "Authorization: Bearer <token>" \
     -d uniqueCurrencyFilter.blockchain=uniqueCurrencyFilter.blockchain \
     -d uniqueCurrencyFilter.network=uniqueCurrencyFilter.network

{
  "result": {
    "name": "string",
    "symbol": "string",
    "coinTypeIndex": "string",
    "blockchain": "string",
    "isToken": true,
    "isERC20": true,
    "decimals": "string",
    "contractAddress": "string",
    "hasStaking": true,
    "isUTXOBased": true,
    "isAccountBased": true,
    "isFiat": true,
    "isFA12": true,
    "isFA20": true,
    "isNFT": true,
    "enabled": true,
    "id": "string",
    "displayName": "string",
    "type": "string",
    "wlcaId": "string",
    "network": "string",
    "tokenID": "string",
    "logo": "string"
  }
}

This endpoint returns a currency. The parameters need to point to a unique currency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

showDisabledbooleanOptional

Set this parameter to true to get a currency even if it is disabled by business rules.

uniqueCurrencyFilter.blockchainstringRequired

uniqueCurrencyFilter.networkstringRequired

uniqueCurrencyFilter.tokenContractAddressstringOptional

If this parameter is set, the currency returned will be a token with the specified contract address. If not set, the currency returned will be the native currency of the blockchain.

uniqueCurrencyFilter.tokenIDstringOptional

For some blockchains (ex. ALGO, XTZ) a tokenContractAddress might contain multiple assets. The tokenID is used to differentiate between those assets. If not set, the currency returned won't have any tokenID defined.

currencyIDstringOptional

includeLogobooleanOptional

Currency logos are omitted by default. Set this to true to include them when applicable.

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error