La section instruments fournit des méthodes pour obtenir une liste des instruments actifs, obtenir des informations sur un instrument individuel et vérifier si l’adresse d’un instrument spécifié est correcte.
Documentation
Description générale
Renvoie une liste publique de tous les instruments actifs (devises et réseaux) disponibles pour l’échange.
Paramètres
Paramètres de requête (Query Parameters)
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
providers |
array[string] | oui | Liste des fournisseurs de liquidité (par ex., BINANCE). Répétez le paramètre pour chaque fournisseur. |
En-têtes
| Nom | Obligatoire | Description |
|---|---|---|
X-Api-Public-Key |
oui | Votre clé API publique. |
X-Api-Timestamp |
oui | Horodatage au format UNIX (ms). |
X-Api-Signature |
oui | Signature HMAC de la requête utilisant votre clé secrète. |
Exemple de requête
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"
Exemple de réponse
[
{
"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"
}
]
Cas d’utilisation
Lors de l’initialisation du formulaire d’échange sur une page web, vous devez afficher toutes les devises et tous les réseaux disponibles provenant des fournisseurs spécifiés. Le frontend appelle cette méthode et construit les listes déroulantes à partir des données retournées.
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
Description générale
Renvoie les informations d’un instrument actif unique (devise + réseau) provenant de la liste publique.
Paramètres
En-têtes (Headers)
| Nom | Obligatoire | Description |
|---|---|---|
X-Api-Public-Key |
oui | Votre clé API publique. |
X-Api-Timestamp |
oui | Horodatage au format UNIX (ms). |
X-Api-Signature |
oui | Signature HMAC du corps de la requête, générée avec votre clé secrète. |
Corps de la requête (JSON)
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
currencyTitle |
string | oui | Code de la devise (par ex. USDT). |
networkTitle |
string | oui | Réseau de la devise (par ex. TRC20). |
Exemple de requête
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"
}'
Exemples de réponses
200 OK — instrument trouvé :
{
"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 — instrument introuvable ou erreur interne :
{
"status": "ERR_UNKNOWN",
"message": "code=404, message=Not Found",
"data": null
}
Cas d’utilisation
Lors de la création d’un ordre, le frontend doit afficher des informations détaillées sur l’instrument sélectionné : nom d’affichage, précision et nécessité d’un Memo/Tag. Une fois la devise et le réseau sélectionnés, cette méthode est appelée et les données renvoyées sont utilisées pour valider et générer les champs du formulaire.
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
Description générale
Valide l’exactitude d’une adresse pour la devise et le réseau spécifiés. Renvoie true si l’adresse respecte le format et les exigences du réseau ; sinon, renvoie false ou une erreur.
Paramètres
En-têtes (Headers)
| Nom | Obligatoire | Description |
|---|---|---|
X-Api-Public-Key |
oui | Votre clé API publique. |
X-Api-Timestamp |
oui | Horodatage au format UNIX (ms). |
X-Api-Signature |
oui | Signature HMAC du corps de la requête, générée avec votre clé secrète. |
Corps de la requête (JSON)
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
currencyTitle |
string | oui | Code de la devise (ex. : USDT). |
networkTitle |
string | oui | Réseau de la devise (ex. : TRC20). |
address |
string | oui | Adresse à valider. |
Exemple de requête
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"
}'
Exemples de réponses
200 OK — adresse valide :
true400 ERR_INVALID_ADDRESS — adresse ne correspond pas au format du réseau :
false500 ERR_UNKNOWN — instrument introuvable ou erreur interne :
{
"status": "ERR_UNKNOWN",
"message": "code=404, message=Not Found",
"data": null
}
Cas d’utilisation
Avant de créer un ordre, le frontend valide l’adresse saisie par l’utilisateur : si true est renvoyé, le formulaire continue ; sinon, un message d’erreur s’affiche invitant l’utilisateur à vérifier l’adresse.
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