A seção instruments fornece métodos para obter uma lista de instrumentos ativos, obter informações sobre um instrumento individual e verificar se o endereço de um instrumento especificado está correto.
Documentation
Descrição geral
Retorna uma lista pública de todos os instrumentos ativos (moedas e redes) disponíveis para troca.
Parâmetros
Parâmetros de consulta (Query Parameters)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
providers |
array[string] | sim | Lista de provedores de liquidez (por exemplo, BINANCE). Repita o parâmetro para cada provedor. |
Headers
| Nome | Obrigatório | Descrição |
|---|---|---|
X-Api-Public-Key |
sim | Sua chave pública da API. |
X-Api-Timestamp |
sim | Timestamp no formato UNIX (ms). |
X-Api-Signature |
sim | Assinatura HMAC da requisição usando sua chave secreta. |
Exemplo de requisição
curl -X GET "https://quickex.io/api/v2/instruments/public?providers=" \
-H "accept: application/json" \
-H "X-Api-Public-Key: yourPublicKey" \
-H "X-Api-Timestamp: 1691400000000" \
-H "X-Api-Signature: yourHmacSignature"
Exemplo de resposta
[
{
"currencyTitle": "ADA",
"networkTitle": "ADA",
"currencyFriendlyTitle": "Cardano",
"precisionDecimals": 11,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
"instrumentType": "crypto"
},
{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"currencyFriendlyTitle": "Tether USD",
"precisionDecimals": 6,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/USDT.png",
"instrumentType": "crypto"
}
]
Caso de uso
Ao inicializar o formulário de troca em uma página web, você deve exibir todas as moedas e redes disponíveis dos provedores especificados. O frontend chama este método e constrói os menus suspensos de moedas e redes com base na lista retornada.
Code Sample
curl -X 'GET' \
'https://quickex.io/api/v2/instruments/public' \
-H 'accept: application/json'Response Example
[
{
"currencyTitle": "STX",
"networkTitle": "STX",
"slug": "stxstx",
"currencyFriendlyTitle": "STX",
"precisionDecimals": 8,
"currencyLogoLink": "https://quickex.io/assets/coins/stx.svg",
"requiresMemo": true,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": ""
},
{
"currencyTitle": "AVAX",
"networkTitle": "AVAX",
"slug": "avax",
"currencyFriendlyTitle": "AVAX",
"precisionDecimals": 3,
"currencyLogoLink": "https://quickex.io/assets/coins/avax.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "AVAX",
"contractAddress": ""
},
{
"currencyTitle": "SAND",
"networkTitle": "ERC20",
"slug": "sanderc20",
"currencyFriendlyTitle": "SAND",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/sand.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
}
]Try it out
Leave empty to use default
Headers
Documentation
Descrição geral
Retorna informações sobre um único instrumento ativo (moeda + rede) da lista pública.
Parâmetros
Headers
| Nome | Obrigatório | Descrição |
|---|---|---|
X-Api-Public-Key |
sim | Sua chave pública da API. |
X-Api-Timestamp |
sim | Timestamp no formato UNIX (ms). |
X-Api-Signature |
sim | Assinatura HMAC do corpo da requisição utilizando sua chave secreta. |
Corpo da requisição (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
currencyTitle |
string | sim | Código da moeda (ex.: USDT). |
networkTitle |
string | sim | Rede da moeda (ex.: TRC20). |
Exemplo de requisição
curl -X POST 'https://quickex.io/api/v2/instruments/public/one' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Public-Key: yourPublicKey' \
-H 'X-Api-Timestamp: 1691400000000' \
-H 'X-Api-Signature: yourHmacSignature' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20"
}'
Exemplos de resposta
200 OK — instrumento encontrado:
{
"currencyTitle": "ADA",
"networkTitle": "ADA",
"currencyFriendlyTitle": "Cardano",
"precisionDecimals": 11,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
"instrumentType": "crypto",
"bestChangeName": "USDTTRC20"
}
500 ERR_UNKNOWN — instrumento não encontrado ou erro interno:
{
"status": "ERR_UNKNOWN",
"message": "code=404, message=Not Found",
"data": null
}
Caso de uso
Ao criar uma ordem, o frontend precisa exibir informações detalhadas sobre o instrumento selecionado: nome de exibição, precisão e necessidade de Memo/Tag. Após o usuário selecionar a moeda e a rede, este método é chamado e os dados retornados são usados para validar e renderizar os campos do formulário.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/instruments/public/one' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20"
}'Response Example
{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"currencyFriendlyTitle": "USDT",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/usdt.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"contractAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t"
}Try it out
Leave empty to use default
Request Body
Headers
Documentation
Descrição geral
Valida a correção de um endereço para a moeda e rede especificadas. Retorna true se o endereço estiver no formato correto e corresponder à rede; caso contrário, retorna false ou um erro.
Parâmetros
Headers
| Nome | Obrigatório | Descrição |
|---|---|---|
X-Api-Public-Key |
sim | Sua chave pública da API. |
X-Api-Timestamp |
sim | Timestamp no formato UNIX (ms). |
X-Api-Signature |
sim | Assinatura HMAC do corpo da requisição, gerada com sua chave secreta. |
Corpo da requisição (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
currencyTitle |
string | sim | Código da moeda (ex.: USDT). |
networkTitle |
string | sim | Rede da moeda (ex.: TRC20). |
address |
string | sim | Endereço a ser validado. |
Exemplo de requisição
curl -X POST 'https://quickex.io/api/v2/instruments/public/validate-address' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Public-Key: yourPublicKey' \
-H 'X-Api-Timestamp: 1691400050000' \
-H 'X-Api-Signature: yourHmacSignature' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"address": "THUmkPhry61edcTf79yTioV6292ccsuCjV"
}'
Exemplos de resposta
200 OK — endereço válido:
true
400 ERR_INVALID_ADDRESS — formato inválido para a rede especificada:
false
500 ERR_UNKNOWN — instrumento não encontrado ou erro interno:
{
"status": "ERR_UNKNOWN",
"message": "code=404, message=Not Found",
"data": null
}
Caso de uso
Antes de criar uma ordem, o frontend valida o endereço inserido pelo usuário: chama este método e, caso true seja retornado, o formulário continua; caso contrário, exibe uma mensagem de erro e solicita ao usuário que verifique o endereço.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/instruments/validate-address' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"address": "THUmkPhry61edcTf79yTioV6292ccsuCjV",
"memo": "2345678",
"getRejectReason": true
}'Response Example
{
"status": "ERR_HTTP",
"message": "Http Exception",
"data": {
"address": "adddress is incorrect"
}
}Try it out
Leave empty to use default