API V2 Instruments

Запрос возвращает публичный список активных инструментов (монет), доступных для использования в системе Bitsz для выбранного провайдера ликвидности.

Метод: GET
URL: https://bitsz.io/api/v2/instruments/public

Пример запроса

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

Параметры запроса (query)

Метод возвращает JSON-массив, где каждый элемент — объект инструмента.

Пример ответа

[
  {
    "currencyTitle": "STX",
    "networkTitle": "STX",
    "slug": "stxstx",
    "currencyFriendlyTitle": "STX",
    "precisionDecimals": 8,
    "currencyLogoLink": "https://bitsz.io/assets/coins/stx.svg",
    "requiresMemo": true,
    "instrumentType": "crypto",
    "bestChangeName": "",
    "contractAddress": ""
  },
  {
    "currencyTitle": "AVAX",
    "networkTitle": "AVAX",
    "slug": "avax",
    "currencyFriendlyTitle": "AVAX",
    "precisionDecimals": 3,
    "currencyLogoLink": "https://bitsz.io/assets/coins/avax.svg",
    "requiresMemo": false,
    "instrumentType": "crypto",
    "bestChangeName": "AVAX",
    "contractAddress": ""
  },
  {
    "currencyTitle": "SAND",
    "networkTitle": "ERC20",
    "slug": "sanderc20",
    "currencyFriendlyTitle": "SAND",
    "precisionDecimals": 2,
    "currencyLogoLink": "https://bitsz.io/assets/coins/sand.svg",
    "requiresMemo": false,
    "instrumentType": "crypto",
    "bestChangeName": "",
    "contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
  }
]

Пример объекта инструмента

{
  "currencyTitle": "SAND",
  "networkTitle": "ERC20",
  "slug": "sanderc20",
  "currencyFriendlyTitle": "SAND",
  "precisionDecimals": 2,
  "currencyLogoLink": "https://bitsz.io/assets/coins/sand.svg",
  "requiresMemo": false,
  "instrumentType": "crypto",
  "bestChangeName": "",
  "contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
}

• Формирование списка валют в форме обмена.
• Предварительная загрузка справочника инструментов для кеширования.
• Проверка, поддерживает ли провайдер нужную сеть или монету.
• Отображение логотипов, названий и правил округления в интерфейсе.
• Валидация вводимых сумм (с учётом precisionDecimals).

Запрос возвращает публичную информацию об одном инструменте (конкретная монета в конкретной сети), доступном в системе Bitsz.

Метод полезен, когда нужно получить детальную информацию об одном инструменте, зная его currencyTitle и networkTitle:

Метод: GET
URL: https://bitsz.io/api/v2/instrument

Пример запроса

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

Параметры запроса (query)

Оба параметра должны одновременно ссылаться на существующий инструмент в системе.

Метод возвращает JSON-объект, описывающий инструмент.

Пример ответа

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

• Получение детальной информации о конкретной монете для отображения на фронтенде.

Метод выполняет проверку корректности адреса и memo> для заданных значений currencyTitle и networkTitle. Используется при создании или валидации ордера, чтобы убедиться, что пользователь ввёл корректный адрес кошелька.
Если проверка проходит успешно, метод возвращает только HTTP-статус `201`> без тела ответа. В случае ошибки возвращается статус `400` и описание причины.

Метод: POST
URL: https://bitsz.io/api/v2/instrument/validate-address

Пример запроса

curl -X 'POST' \
  'https://bitsz.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
  }'

Параметры запроса (body)

Если адрес валиден, метод возвращает только код статуса:

Пример ответа

    201

Ошибка (400)

Если адрес или memo некорректны, метод возвращает объект ошибки.

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

Пример объекта ошибки

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

• Валидация адреса перед созданием ордера.
• Проверка Memo/Tag/Payment ID для сетей, где он требуется.
• Проверка форм ввода адреса кошелька на стороне партнёра.
• Предотвращение отправки средств на неверный адрес.
• Отображение пользователю подробного сообщения о валидации, если адрес некорректен.