Open APIs pro Mercator

Specificatio

Praefixum

1. Ut securitatem transactionis assecurent, HTTPS ad transmissionem utere.
2. JSON est forma interchangendi data.
3. Codificatio characterum UTF-8 universaliter applicatur.
4. Algorithmi signandi interface HMAC-SHA256 utitur.
5. Timestamp millisecondum UNIX adhibetur, numerum millisecondorum a die 1 Ianuarii 1970, 0:00:00 repraesentans.

Parametri

Petitio

Responsio

Generatio Signaturae

Nostra RFQ suggestum signaturas sociorum ad approbandum petitiones requirit, sequitur procedura verificationis. Defectus verificationis ad reiectionem suggesti cum responsione 401 Non auctorizato ducet.

Constructio signaturae string:

Signatura string quinque lineas continet, quae singula parametra repraesentant. Unaquaeque linea cum semicolon finitur, etiam ultima linea. Validum timestamp et nonce petitionis ex parametris H-Timestamp et H-Nonce in capite, respective, sumuntur.

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

Complens signaturam

Utere SecretKey ad encryptandum StringToSign utens HMAC-SHA256.

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

Statum HTTP Capita

Petitionem signaturam per HTTP Authorization caput transmitit. Authorization header duabus partibus consistit: typus authenticationis et notitia signaturae.

Authorization: AuthenticationType SignatureInformation

1. Typus Authenticationis: [mm_id]-hmac-sha256
2. Notitia Signaturae: Signature

Authorization: [mm_id]-hmac-sha256 Signature

Nota:

• Modus petitionis in UPPERCASE esse debet.
• RequestBody ad signaturam usus contentum corporis petitionis convenire debet.
• Pro petitionibus GET et DELETE, URI parametra petitionis includere debet (exempli gratia, /api/v1/result?orderId=123).
  • Si corpus petitionis non est (communis pro petitionibus GET), corpus petitionis esse debet stringa vacua ("").
• Validum timestamp (H-Timestamp) a petente determinatur; petitiones ultra validum timestamp a servo RFQ reiciuntur.

RFQ

Praebe DNT RFQ Citatum

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

Praebe Bull/Bear Trend RFQ Citationem

GET rfq/smart-trend/quote

Parametri

Responsio

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

Responsum

Appendix

Functiones Necessariae：

• $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$