Открытые API для маркетмейкера

Спецификация

Префикс

1. Для обеспечения безопасности транзакций используйте HTTPS для передачи данных.
2. JSON является форматом обмена данными.
3. Кодировка символов UTF-8 применяется повсеместно.
4. Алгоритм подписи интерфейса использует HMAC-SHA256.
5. Используется временная метка UNIX в миллисекундах, представляющая количество миллисекунд с 1 января 1970 года, 0:00:00.

Параметры

Запрос

Ответ

Генерация подписи

Наша платформа RFQ требует подписи партнеров для одобрения запросов, за которыми следует процедура проверки. Ошибка проверки приведет к отказу платформы с ответом 401 Unauthorized.

Формирование строки подписи:

Строка подписи состоит из пяти строк, каждая из которых представляет параметр. Каждая строка заканчивается точкой с запятой, включая последнюю строку. Действительная временная метка и nonce запроса берутся из параметров H-Timestamp и H-Nonce в заголовке соответственно.

Timestamp;NonceStr;HTTP_METHOD();URI();RequestBody;

Заполнение подписи

Используйте SecretKey для шифрования StringToSign с помощью HMAC-SHA256.

StringToSign = Timestamp + ";" + NonceStr + ";" + UPPERCASE(HTTP_METHOD()) + ";" + URI() + ";" + RequestBody + ";";
Signature = BASE64_STRING( HMAC-SHA256( BASE64_DECODE(SecretKey), StringToSign ) );

Установка HTTP заголовков

Запрос передает подпись через заголовок HTTP Authorization. Заголовок Authorization состоит из двух частей: тип аутентификации и информация о подписи.

Authorization: AuthenticationType SignatureInformation

1. Тип аутентификации: [mm_id]-hmac-sha256
2. Информация о подписи: Signature

Authorization: [mm_id]-hmac-sha256 Signature

Примечание:

• Метод запроса должен быть написан заглавными буквами.
• RequestBody, используемое для подписи, должно соответствовать содержимому тела запроса.
• Для запросов GET и DELETE URI должен включать параметры запроса (например, /api/v1/result?orderId=123).
  • Если тело запроса отсутствует (что обычно для запросов GET), тело запроса должно быть пустой строкой ("").
• Действительная метка времени (H-Timestamp) определяется запрашивающей стороной; запросы, превышающие действительную метку времени, будут отклонены сервером RFQ.

RFQ

Предоставить котировку DNT RFQ

GET rfq/dnt/quote

Параметры

Ответ

Note:

1. $collateralAtRisk - makerCollateral == premiumAmount$
2. $totalCollateral - makerCollateral == depositAmount$

Примеры

URL запроса

rfq/dnt/quote

Параметры

{
    "rfqId":1233992,
    "apy":0.25,
    "tenor":7.9,
    "fundingAmount":0.01,
    "depositAmount":1,
    "premiumCoin":"BTC",
    "premiumAmount":0.05,
    "bookingQuantity":1,
    "totalAmount":0.05,
    "payoff":1,
    "deadline":1672279892000,
    "signature":"dsdkksdsksdk"
}

Предоставить заявку на котировку бычьего/медвежьего тренда

GET rfq/smart-trend/quote

Параметры

Ответ

Примечание:

• $PremiumAmount = BookingQuantity * UnitQuotePrice$
• $MaxPayoutAmount = BookingQuantity * (upperStrike - lowerStrike)$
• $MinAPYAmount == projectedFundingAmount - premiumAmount$
• $MaxAPYAmount == MinAPYAmount + MaxPayoutAmount$
• $makerCollateral = MaxPayoutAmount - premiumAmount$
• $collateralAtRisk = MaxPayoutAmount$
• $totalCollateral = depositAmount + makerCollateral$
• $anchorPrices = [lowerStrike, upperStrike]$

Предоставить двойную котировку RFQ

GET rfq/dual/quote

Параметры

Response

Appendix

Required Functions：

• $premiumAmount = collateralAtRisk - makerCollateral$
• $depositAmount = totalCollater - makerCollateral$
• $bookingQuantity = collateralAtRisk$
• $projectedFundingAmount = projectedFundingAPY * (expDateTime - refDateTime) / 365$
• $Tenor = (expDateTime - refDateTime) / 365$
• $APYInRange = (projectedFundingAmount - premiumAmount + bookingQuantity) / tenor = makerCollateral / tenor$
• $APY-Protected = (projectedFundingAmount - premiumAmount) / tenor$