Get currency information
Get currencies and their properties
info
If any currency is disabled by Changelly, it will be returned in the response list with the "enabled": false
property.
HTTP request
post
/v2/#getCurrenciesFull
Request
Header parameters
Requires authentification.
Body parameters
Requires JSON-RPC 2.0 protocol request body.
The params
parameter schema:
Name | Type | Required | Description |
---|---|---|---|
params | object | false | Request parameters. |
Sample request payload
application/json
{
"jsonrpc": "2.0",
"id": "test",
"method": "getCurrenciesFull",
"params": {}
}
Sample cURL
curl --location --request POST 'https://api.changelly.com/v2' \
--header 'X-Api-Key: {{apiKey}}' \
--header 'X-Api-Signature: {{sign}}' \
--data-raw '{
"id": "test",
"jsonrpc": "2.0",
"method": "getCurrenciesFull",
"params": {}
}'
Response
info
By default, getCurrenciesFull
returns protocol
and blockchain
. If you prefer to receive information about the coin
+ network
combination instead, please contact us at [email protected].
After this change, getCurrenciesFull
won't return protocol
and blockchain
but return coin
and network
instead.
Response parameters
Requires JSON-RPC 2.0 protocol response body.
The result
parameter schema:
Name | Type | Description |
---|---|---|
name | string | Currency name. |
ticker | string | Currency ticker. |
fullname | string | Currency full name. |
enabled | boolean | Enabled for exchange. |
enabledFrom | boolean | Enabled for exchange as a payin currency. |
enabledTo | boolean | Enabled for exchange as a payout currency. |
fixRateEnabled | boolean | Enabled for exchange in the fixed rate transactions. |
payinConfirmations | integer | Amount of payin confirmations for currency. |
extraIdName | string | Name of the currency extra ID (if applicable). If extra ID is not applicable, the parameter is not returned. |
addressUrl | string | Blockchain address URL. |
transactionUrl | string | Transaction URL. |
image | string | Currency image URL. |
fixedTime | number | The time in milliseconds that is given to user to pay for a fixed transaction. The fixedTime depends on the currency. |
contractAddress | string | Contract address refers to the address where the contract is deployed on the blockchain. Parameter is returned only if the currency has any contract address. |
protocol | string | Currency protocol. |
blockchain | string | Currency blockchain. |
blockchainPrecision | integer | Maximum number of decimal places in currency blockchain precision. |
notifications | object | Notifications that the user gets about the currency. Parameter is returned only if the currency has any notification. |
coin | string | Currency token symbol. By default, getCurrenciesFull returns protocol and blockchain . However, it can be changed to the the coin + network combination instead on request.This feature can provide an accessible way to understand the details of individual currencies. |
network | string | Network on which currency is transacted. By default, getCurrenciesFull returns protocol and blockchain . However, it can be changed to the the coin + network combination instead on request.This feature can be useful when users need to select or confirm the specific network within their wallet or platform. Incorrect network selection may result in the loss of funds. Therefore, it is crucial to ensure that the network is correctly identified. |
»payin | string | Notification that the user gets about the currency if this is payin currency. Parameter is returned only if the payin currency has any notification. |
»payout | string | Notification that the user gets about the currency if this is payout currency. Parameter is returned only if the payout currency has any notification. |
Sample response with blockchain
and protocol
application/json
{
"jsonrpc": "2.0",
"id": "test",
"result": [
{
"name": "BTC",
"ticker": "btc",
"fullName": "Bitcoin",
"enabled": true,
"enabledFrom": true,
"enabledTo": true,
"fixRateEnabled": true,
"payinConfirmations": 2,
"addressUrl": "https://www.blockchain.com/btc/address/%1$s",
"transactionUrl": "https://www.blockchain.com/btc/tx/%1$s",
"image": "https://cdn.changelly.com/icons/btc.png",
"fixedTime": 1200000,
"protocol": "BTC",
"blockchain": "bitcoin",
"blockchainPrecision": 8
},
{
"name": "BETR",
"ticker": "betr",
"fullName": "BetterBetting",
"enabled": false,
"enabledFrom": false,
"enabledTo": false,
"fixRateEnabled": false,
"payinConfirmations": 15,
"addressUrl": "https://etherscan.io/token/0x763186e************1214febc6a9?a=%1$s",
"transactionUrl": "https://etherscan.io/tx/%1$s",
"image": "https://cdn.changelly.com/icons/betr.png",
"fixedTime": 0,
"contractAddress": "0x763186e***************1214febc6a9",
"protocol": "ERC20",
"blockchain": "ethereum",
"blockchainPrecision": 18
}
]
}
Sample response with coin
and network
application/json
{
"jsonrpc": "2.0",
"id": "test",
"result": [
{
"name": "USDT20",
"ticker": "usdt20",
"fullName": "Tether ERC20",
"enabled": true,
"enabledFrom": true,
"enabledTo": true,
"fixRateEnabled": true,
"payinConfirmations": 15,
"addressUrl": "https://etherscan.io/token/0xdac***************831ec7?a=%1$s",
"transactionUrl": "https://etherscan.io/tx/%1$s",
"image": "https://cdn.changelly.com/icons/usdt20.png",
"fixedTime": 900000,
"coin": "usdt",
"network": "eth",
"contractAddress": "0xdac***************831ec7",
"blockchainPrecision": 18
}
]
}
Error response
Error response parameters
Check the error response schema.
Error codes
Code | Message | Description |
---|---|---|
-32600 | Error: You reached requests limit {limit} rps | You have been sending more than 10 requests per second. |
-32603 | Internal Error or Error | Most likely, the problem is on our side. Further investigation is required. |