Open APIs for Market Maker

Specification

Prefix

1. To ensure transaction security, use HTTPS for transmission.
2. JSON is the data interchange format.
3. UTF-8 character encoding is universally applied.
4. Interface signing algorithm utilizes HMAC-SHA256.
5. UNIX millisecond timestamp is used, representing the number of milliseconds since January 1, 1970, 0:00:00.

Parameters

Request

Response

Signature Generation

Our RFQ platform requires partner signatures to approve requests, followed by a verification procedure. A verification failure will lead to a platform rejection with a 401 Unauthorized response.

Building the signature string:

The signature string consists of five lines, each representing a parameter. Each line ends with a semicolon, including the last line. The valid timestamp and the request nonce are taken from the H-Timestamp and H-Nonce parameters in the header, respectively.

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

Populating the signature

Use the SecretKey to encrypt StringToSign using HMAC-SHA256.

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

Setting HTTP Headers

The request transmits the signature through the HTTP Authorization header. The Authorization header comprises of two parts: authentication type and signature information.

Authorization: AuthenticationType SignatureInformation

1. Authentication Type: [mm_id]-hmac-sha256
2. Signature Information: Signature

Authorization: [mm_id]-hmac-sha256 Signature

Note:

• The request method should be in UPPERCASE.
• The RequestBody used for the signature must match the content of the request's body.
• For GET and DELETE requests, the URI should include the request parameters (e.g., /api/v1/result?orderId=123).
  • If there is no request body (common for GET requests), the request body should be an empty string ("").
• The valid timestamp (H-Timestamp) is determined by the requester; requests extending beyond the valid timestamp will be rejected by the RFQ server.

RFQ

Provide DNT RFQ Quote

GET rfq/dnt/quote

Parameters

Response

Note:

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

Examples

Request URL

rfq/dnt/quote

Parameters

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

Provide Bull/Bear Trend RFQ Quote

GET rfq/smart-trend/quote

Parameters

Response

Note:

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

Provide Dual RFQ Quote

GET rfq/dual/quote

Parameters

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$