DApp Open APIs

Our existing dApp on sofa.org is a critical workflow feature and is the main way for users to interact with the SOFA protocols. However, we encourage other developers to enable access and connect to SOFA via their own dApps as well to maximize our ecosystem growth. We consider these to be our 'Broker' partners and encourage interested parties to contact the SOFA team for further API information.

DNT

Recommended DNT RFQ list Inquiry

GET /rfq/dnt/recommended-list

Input parameters

Response Parameters

Object

Request Example

GET rfq/dnt/recommended-list?vault=xxxxxx&chainId=1

Response

{
    "code":0,
    "message":"",
    "value":[
        {
            "rfqId":1233992,
            "riskType":"PROTECTED",
            "forCcy":"BTC",
            "expiry":1672387200,
            "lowerBarrier":18000,
            "upperBarrier":24000,
            "depositCcy":"BTC",
            "depositAmount": 0.05,
            "protectedApy":0.01,
            "deadline":1672279892,
            "recommended":true,
            "quote":
                {
                    "rfqId":1233992,
                    "inRangeApy":0.25,
                    "tenor":7.9,
                    "fundingAmount":0.25,
                    "depositAmount":1,
                    "premiumCoin":"BTC",
                    "premiumAmount":0.05,
                    "bookingQuantity":0.3,
                    "totalAmount":0.05,
                    "payoff":0.3,
                    "deadline":1672279892,
                    "signature":"dsdkksdsksdk"
                }

        }
    ]
}

DNT Inquiry

• Notes:
  • Please do not pass the user's wallet address on a pure inquiry request.
  • A user's wallet address should be passed on only upon subscribing.

GET /rfq/dnt/quote

Input Parameters

Response Parameters

Object

DNT Winning Probability

Probability of staying within the boundaries until expiry

GET rfq/dnt/winning-probabilities

Input Parameters

Response Parameters

Object

Request Example

GET rfq/dnt/winning-probabilities?forCcy=BTC&expiry=xxxx&lowerBarrier=xxx&upperBarrier=xxx

Response

{
    "code":0,
    "message":"",
    "value": {
        "spotPrice": 62121,
        "timestamp": 1727080594,
        "probabilities": {
            "probDntStayInRange": 0.4
            "probBullTrendItmLowerStrike": null,
            "probBullTrendItmUpperStrike": null,
            "probBearTrendItmLowerStrike": null,
            "probBearTrendItmUpperStrike": null,
        }
    }
}

Smart Trend

Recommended Smart Trend RFQ list Inquiry

GET rfq/smart-trend/recommended-list

Input parameters

Response Parameters

Object

Request Example

GET rfq/smart-trend/recommended-list?vault=xxxxxx

Smart Trend Inquiry

• Notes:
  • Please do not pass the user's wallet address on a pure inquiry request.
  • A user's wallet address should be passed on only upon subscribing.

GET /rfq/smart-trend/quote

Input Parameters

Response Parameters

Object

Smart Trend Winning Probability

Probability of staying within the boundaries until expiry

GET rfq/smart-trend/winning-probabilities

Input Parameters

Response Parameters

Object

Request Example

GET rfq/smart-trend/winning-probabilities?forCcy=BTC&expiry=xxxx&lowerStrike=xxx&upperStrike=xxx

Response

{
    "code":0,
    "message":"",
    "value": {
        "spotPrice": 62121,
        "timestamp": 1727080594,
        "probabilities": {
            "probDntStayInRange": null,
            "probBullTrendItmLowerStrike": 0.4,
            "probBullTrendItmUpperStrike": 0.4,
            "probBearTrendItmLowerStrike": 0.6,
            "probBearTrendItmUpperStrike": 0.6,
        }
    }
}

Generic Interface

Delete RFQ

Delete the RFQ that has been on-chain

POST rfq/remove

Input Parameters

Request Example

{  
"rfqId":123456  
}

Response Parameters

Transaction notification

POST rfq/trade

Input Parameters

Request Example

{
    "quotes": [
        {
            "rfqId": 123456,
            "quoteId": 333,
            "txId": "adsswe"
        }
    ],
    "code": "adsswe"
}

Response Parameters

Strike list

GET rfq/strike-list

Input Parameters

Request Example

{  
"indexPrice": 3750.8，  
"forCcy": "WBTC",  
}

Response Parameters

Expiry list

GET rfq/expiry-list

Input Parameters

Request Example

{  
"vault": "XXXXXXXXXXXXXX",  
"chainId": 1,  
}

Response Parameters

Aave apy

GET rfq/aave-apy

Input Parameters

Response Parameters

Response Example

{  
"chainId": 1,  
"ccy":"USDT",  
"avgApy":"0.23442",  
"currentApy":"0.23442",  
"apyUsed":"0.23442",  
"apyDefinition":"AAVE_LENDING_APY"  
}

Apy

GET rfq/apy

Input Parameters

Response Parameters

Response Example

{  
"chainId": 1,  
"ccy":"USDT",  
"avgApy":"0.23442",  
"currentApy":"0.23442",  
"apyUsed":"0.23442",  
"apyDefinition":"AAVE_LENDING_APY"  
}

Get Wallet Positions

POST /rfq/position-list

Input Parameters

Note: If the number of results exceeds 300 within the specified startDateTime and endDateTime, polling can be used (in this case, orderBy must be set to "createdAt") to continue querying. The endDateTime parameter for the nth polling request should be set to the createdAt of the last record from the (n-1)th polling result. After retrieving all data, duplicates should be removed based on the id field.

Response Parameters

Object

Response Example

{
    "value": [{
        ...
    }]
}

Get Wallet Transactions

POST /rfq/transaction-list

Input Parameters

Note: Taker, maker, and claimParams parameters can be used for a joint query to find the trade records corresponding to a position (a position may correspond to multiple trades) (not all parameters are required). If the number of results exceeds 300 within the specified startDateTime and endDateTime, polling can be used (in this case, orderBy must be set to "createdAt") to continue querying. The endDateTime parameter for the nth polling request should be set to the createdAt of the last record from the (n-1)th polling result. After retrieving all data, duplicates should be removed based on the id field.

Response Parameters

Object

Response Example

{
    "value": [{
        ...
    }]
}

Conceal loss positions

POST rfq/position/conceal

Input Parameters

Request Example

{
    "positionIds": [
        "aaaa","bbbb"
    ],
    "chainId": 1
}

Response Parameters

Get Pending Transactions

This is mainly to address the underlying position data synchronization issue. The data retrieved here may disappear (due to blockchain fork competition).

POST rfq/transactions/pending

Input Parameters

Response Parameters

Object

Get RCH Airdrop History

GET rfq/airdrop/history

Input Parameters

Response Parameters

Object