Swagger

Our Swap, Intent, and Price API will be discontinued permanently on 31.10.24

Requests a quote from PropellerSolver

Return a quote for a certain blockchain and orders.

POST/v2/solver/quote

Query parameters

Body

application/json

orders*Orders

ammsAmms

Response

200204400404422500503

Successful Response

Body

application/json

request_id*Request Id

quotes*Quotes

gas*Gas

target_address*Target Address

buy_tokensBuy Tokens

sell_tokensSell Tokens

Request

JavaScriptCurlPython

const response = await fetch('/v2/solver/quote?blockchain=ethereum', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orders": [
        {
          "origin_address": "0x0000000000000000000000000000000000000000",
          "sell_token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "buy_token": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
          "sell_amount": "10000000000000",
          "buy_amount": "1000000000000000000000"
        },
        {
          "origin_address": "0x0000000000000000000000000000000000000000",
          "sell_token": "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599",
          "buy_token": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
          "sell_amount": "10000000000",
          "buy_amount": "10000000000000000000"
        }
      ],
      "amms": [
        "+all"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "request_id": "text",
  "quotes": [
    {
      "sell_token": "text",
      "buy_token": "text",
      "sell_amount": "text",
      "buy_amount": "text",
      "external_id": "text"
    }
  ],
  "target_address": "text",
  "buy_tokens": [],
  "sell_tokens": []
}

Requests a solution from PropellerSolver

Process a solve request for a given blockchain.

POST/v2/solver/solve

Query parameters

Body

application/json

orders*Orders

ammsAmms

Response

200204400404422500503

Successful Response

Body

application/json

request_id*Request Id

solutions*Solutions

buy_tokensBuy Tokens

sell_tokensSell Tokens

routesRoutes

Request

JavaScriptCurlPython

const response = await fetch('/v2/solver/solve?blockchain=ethereum', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orders": [
        {
          "origin_address": "0x0000000000000000000000000000000000000000",
          "sell_token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "buy_token": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
          "sell_amount": "10000000000000",
          "buy_amount": "1000000000000000000000"
        },
        {
          "origin_address": "0x0000000000000000000000000000000000000000",
          "sell_token": "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599",
          "buy_token": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
          "sell_amount": "10000000000",
          "buy_amount": "10000000000000000000"
        }
      ],
      "amms": [
        "+all"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "request_id": "text",
  "solutions": [
    {
      "orders": [
        {
          "origin_address": "text",
          "sell_token": "text",
          "buy_token": "text",
          "sell_amount": "text",
          "executed_sell_amount": "text",
          "buy_amount": "text",
          "executed_buy_amount": "text",
          "external_id": "text",
          "receiver": "text"
        }
      ],
      "call_data": "text",
      "gas": "text",
      "target_address": "text"
    }
  ],
  "buy_tokens": [],
  "sell_tokens": []
}

Get current nonce for dutch auction orders

Get current nonce for a given address. This endpoint will return the next valid nonce to be used in order creation.

GET/v2/intent/nonce

Query parameters

Response

200400403404422500

Successful Response

Body

application/json

nonce*Nonce

Request

JavaScriptCurlPython

const response = await fetch('/v2/intent/nonce', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "nonce": "text"
}

Submit an intent order.

Submit an intent order to PropellerSolver.

POST/v2/intent/order

Authorization

APIKeyHeader

Body

application/json

blockchain*Blockchain

An enumeration.

ethereumavalanchefantomzksyncbscoffchainsteparbitrumpolygonstarknet

order*Order

signature*Signature

quote_idQuote Id

Response

200400403404422500

Successful Response

Body

application/json

hash*Hash

Request

JavaScriptCurlPython

const response = await fetch('/v2/intent/order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "blockchain": "ethereum",
      "order": "0xa9059cbb0000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643000000000000000000000000000000000000000000000016345785d8a0000",
      "signature": "0x2b5634c4206f3192b8bb7c5a6534663e52a02f5063c2f11372400b80911af5eb3b287e301f0238558d9c641c89843a48f4e9ae65024fb16805568959872ef8821b",
      "quote_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }),
});
const data = await response.json();

Response

200422

{
  "hash": "text"
}

Retrieve intent orders

Return orders filtered by query param(s).

GET/v2/intent/orders

Query parameters

Response

200400403404422500

Successful Response

Body

application/json

orders*Orders

cursorCursor

Request

JavaScriptCurlPython

const response = await fetch('/v2/intent/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "orders": [
    {
      "chain": "ethereum",
      "type": "Dutch",
      "encoded_order": "text",
      "signature": "text",
      "nonce": "text",
      "order_hash": "text",
      "order_status": "open",
      "swapper": "text",
      "reactor": "text",
      "input": {
        "token": "text",
        "start_amount": "text",
        "end_amount": "text"
      },
      "outputs": [
        {
          "token": "text",
          "start_amount": "text",
          "end_amount": "text",
          "recipient": "text"
        }
      ],
      "filler": "text",
      "quote_id": "text",
      "tx_hash": "text",
      "settled_amounts": [
        {
          "token_out": "text",
          "amount_out": "text",
          "token_in": "text",
          "amount_in": "text"
        }
      ]
    }
  ],
  "cursor": "text"
}