Getting Started

In this section, we'll walk though the initial steps required to integrate Upshot platform as a liquidity source.

API

Our API will find the best liquidity source prices from our market makers that the trading needs.

Please contact the team for more detail.

Quote user/rfq

This API allows users to request quotes for trading tokens, ensuring they receive the best available prices from our market makers.

Quote RFQ

The Quote RFQ is designed to users in requesting quotes and finding the best liquidity source prices from our market makers. Here’s a API Spec.

POST /user/rfq

Headers

Name	Value
Content-Type	application/json

Body

{
  "source": "string",
  "baseChain": {
    "chainType": "string", // supported only evm
    "chainId": "number"
  },
  "quoteChain": {
    "chainType": "string", // supported only evm
    "chainId": "number" // quoteChainId must be equal to baseChainId
  },
  "rfqs": [
    {
      "baseToken": "string",
      "quoteToken": "string",
      "baseTokenAmount": "string",
      "trader": "string",
      "effectiveTrader": "string"
    }
  ]
}

Response

200

{
  "quoteData": {
    "baseChain": {
      "chainType": string, // evm 
      "chainId": number
    }, 
    "quoteChain": {
      "chainType": string, // evm 
      "chainId": number
    },
    "baseToken": string,
    "baseTokenAmount": string,
    "quoteToken": string,
    "quoteTokenAmount": string,
    "trader": string,
    "effectiveTrader": ?string,
    "txid": string,  // Unique quote identifier. Different from RFQ ID.
    "pool": string,
    "quoteExpiry": number,
    "nonce": number,
    "externalAccount": ?string,
  },
  "signature": string,
  "targetContract": string,
  "calldata": string
}

400

{
  "status": "fail",
  "error": ""
}

404

{
  "status": "fail",
  "error": "quote not found"
}