API V2 Instruments

La solicitud devuelve una lista pública de instrumentos activos (monedas) disponibles para su uso dentro del sistema Quickex para un proveedor de liquidez seleccionado.

Método: GET
URL: https://quickex.io/api/v2/instruments/public

Ejemplo de solicitud

curl -X 'GET' \
  'https://quickex.io/api/v2/instruments/public?providers=hat' \
  -H 'accept: application/json'

Parámetros de consulta (query)

El método devuelve un array JSON donde cada elemento es un objeto de instrumento.

Ejemplo de respuesta

[
  {
    "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"
  }
]

Ejemplo de un objeto de instrumento

{
  "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"
}

• Construir una lista de monedas en un formulario de intercambio.
• Precargar el directorio de instrumentos para almacenarlo en caché.
• Comprobar si la red o la moneda requerida está soportada por el proveedor.
• Mostrar logotipos, nombres y reglas de redondeo en la interfaz de usuario.
• Validar los importes introducidos (teniendo en cuenta precisionDecimals).

La solicitud devuelve información pública sobre un único instrumento (una moneda específica en una red específica) disponible en el sistema Quickex.

El método es útil cuando necesitas obtener información detallada sobre un instrumento concreto, conociendo sus valores de currencyTitle y networkTitle:

Método: GET
URL: https://quickex.io/api/v2/instrument

Ejemplo de solicitud

curl -X 'GET' \
  'https://quickex.io/api/v2/instrument?currencyTitle=ADA&networkTitle=ADA' \
  -H 'accept: application/json'

Parámetros de consulta (query)

Ambos parámetros deben referirse simultáneamente a un instrumento existente en el sistema.

El método devuelve un objeto JSON que describe el instrumento.

Ejemplo de respuesta

{
  "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",
  "contractAddress": "string"
}

{
  "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",
  "contractAddress": "string"
}

• Obtener información detallada sobre una moneda específica para mostrarla en el frontend.

El método comprueba la validez de la dirección y del memo para los valores dados de `currencyTitle` y `networkTitle`. Se utiliza durante la creación o validación de una orden para asegurarse de que el usuario ha introducido una dirección de monedero correcta.
Si la validación se realiza correctamente, el método devuelve solo el código de estado HTTP `201` sin cuerpo de respuesta. En caso de error, devuelve el estado `400` y una descripción del motivo.

Método: POST
URL: https://quickex.io/api/v2/instrument/validate-address

Ejemplo de solicitud

curl -X 'POST' \
  'https://quickex.io/api/v2/instrument/validate-address' \
  -H 'accept: */*' \
  -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
  -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
  -H 'X-Api-Signature: {SIGNATURE}' \
  -H 'Content-Type: application/json' \
  -d '{
    "currencyTitle": "USDT",
    "networkTitle": "TRC20",
    "address": "THUmkPhry61edcTf79yTioV6292ccsuCjV",
    "memo": "2345678",
    "getRejectReason": true
  }'

Parámetros de consulta (query)

Si la dirección es válida, el método devuelve solo el código de estado:

Ejemplo de respuesta

    201

Error (400)

Si la dirección o el memo no son válidos, el método devuelve un objeto de error.

        {
      "status": "ERR_HTTP",
      "message": "Http Exception",
      "data": {
        "address": "adddress is incorrect"
      }
    }

Ejemplo de un objeto de error

      {
      "status": "ERR_HTTP",
      "message": "Http Exception",
      "data": {
        "address": "adddress is incorrect"
      }
    }

• Validar la dirección antes de crear una orden.
• Validar Memo/Tag/Payment ID para redes que lo requieren.
• Validar formularios de dirección de monedero en el lado del socio.
• Evitar que los fondos se envíen a una dirección incorrecta.
• Mostrar a los usuarios un mensaje de validación detallado cuando la dirección es incorrecta.