Skip to content

v2.md

Latest commit

 

History

History
148 lines (110 loc) · 4.16 KB

v2.md

File metadata and controls

148 lines (110 loc) · 4.16 KB

V2 Endpoints

All Mojitoswap V2 pairs consist of two different tokens. KCS is not a native currency in Mojitoswap V2, and is represented only by WKCS in the V2 pairs.

/v2/summary

Returns data for the top ~1000 Mojitoswap V2 pairs, sorted by reserves. Results are edge cached for 15 minutes.

Request

GET {host}/v2/summary

Response

{
  "0x..._0x...": {                  // the asset ids of the ERC20 tokens (i.e. token addresses), joined by an underscore
    "last_price": "1.234",          // denominated in token0/token1
    "base_volume": "123.456",       // last 24h volume denominated in token0
    "quote_volume": "1234.56"       // last 24h volume denominated in token1
  },
  // ...
}

/v2/assets

Returns the tokens in the top ~1000 pairs on Mojitoswap V2, sorted by reserves. Results are edge cached for 24 hours.

Request

GET {host}/v2/assets

Response

{
  // ...,
  "0x...": {              // the address of the ERC20 token
    "name": "...",        // not necesssarily included for ERC20 tokens
    "symbol": "...",      // not necesssarily included for ERC20 tokens
    "id": "0x...",        // the address of the ERC20 token
    "maker_fee": "0",     // always 0
    "taker_fee": "0.003", // always 0.003 i.e. .3%
  },
  // ...
}

/v2/tickers

Returns data for the top ~1000 Mojitoswap V2 pairs, sorted by reserves. Results are edge cached for 1 minute.

Request

GET {host}/v2/tickers

Response

{
  "0x..._0x...": {                    // the asset ids of ETH and ERC20 tokens, joined by an underscore
    "base_name": "...",             // token0 name
    "base_symbol": "...",           // token0 symbol
    "base_id": "0x...",             // token0 address
    "quote_name": "...",            // token1 name
    "quote_symbol": "...",          // token1 symbol
    "quote_id": "0x...",            // token1 address
    "last_price": "1.234",          // the mid price as token1/token0
    "base_volume": "123.456",       // denominated in token0
    "quote_volume": "1234.56"       // denominated in token1
  },
  // ...
}

/v2/orderbook/:pair

Returns simulated orderbook data for the given Mojitoswap V2 pair. Since Mojitoswap has a continuous orderbook, fixed amounts in an interval are chosen for bids and asks, and prices are derived from the Mojitoswap V2 formula (accounting for both slippage and fees paid to LPs). Results are edge cached for 240 minutes.

Request

GET {host}/v2/orderbook/:pair

URL Parameters

  • pair: The asset ids of two ERC20 tokens, joined by an underscore, e.g. 0x..._0x.... The first token address is considered the base in the response.

Response

{
  "timestamp": 1234567, // UNIX timestamp of the response
  "bids": [
    ["12", "1.2"],      // denominated in base token, quote token/base token
    ["12", "1.1"],      // denominated in base token, quote token/base token
    // ...
  ],
  "asks": [
    ["12", "1.3"],      // denominated in base token, quote token/base token
    ["12", "1.4"],      // denominated in base token, quote token/base token
    // ...
  ]
}

/v2/trades/:pair

Returns all swaps in the last 24 hours for the given Mojitoswap V2 pair. Results are edge cached for 15 minutes.

The pair address is the address of the two tokens in either order. The first address is considered the base in the response.

Note because Mojitoswap V2 supports flash swaps and borrowing of both tokens in a pair, you may wish to exclude these trade types (types "???" and "borrow-both").

URL Parameters

  • pair: The asset ids of two ERC20 tokens, joined by an underscore, e.g. 0x..._0x.... The first token address is considered the base in the response.

Request

GET {host}/v2/trades/:pair

Response

[
  {
    "trade_id": "...",
    "price": "1.234",           // denominated in quote token/base token
    "base_volume": "123.456",   // denominated in base token
    "quote_volume": "1234.56",  // denominated in quote token
    "trade_timestamp": 1234567, // UNIX timestamp
    "type": "buy"               // "buy"/"sell"/"borrow-both"/"???" 
  },
  // ...
]