API Specification

Our API is defined using the OpenAPI 3.0 specification. You can easily explore and test the endpoints using tools like Swagger UI, or Postman. For convenience, you can interact with our API on our hosted SwaggerUI page: https://app.runesdex.com/v1/swagger

You can also quickly send sample API requests using the API Explorer below. If you'd prefer to use a tool like Postman, download our OpenAPI spec available at: https://app.runesdex.com/v1/swagger/swagger.yaml

API Explorer

Healthcheck endpoint

This endpoint is used to check if the service is up and running.\

GET/v1/healthcheck

Response

200

Ok Status

Request

JavaScriptCurlPython

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

Version endpoint

This endpoint is used to get the version of the service.\

GET/v1/version

Response

200

App Info

Body

application/json

app*string

Example: "runes_dex"

build*string

Example: "main"

commit*string

Example: "03798661f49a25592975d96bf9a80b9b0555ae5a"

version*string

Example: "0.4.5"

Request

JavaScriptCurlPython

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

Response

200

{
  "app": "runes_dex",
  "build": "main",
  "commit": "03798661f49a25592975d96bf9a80b9b0555ae5a",
  "version": "0.4.5"
}

List known runes

This endpoint is used to list known runes.

GET/v1/runes

Query parameters

Response

200400500

List of matched runes

Body

application/json

metaListResponseMeta

recordsarray of Rune

Request

JavaScriptCurlPython

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

Response

200400500

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": false,
    "total_records": 123
  },
  "records": [
    {
      "id": "3009048:5",
      "rune": "MAXDECIMALSRUNESOBIG",
      "display_name": "MAXDECIMALSRUNESOBIG",
      "symbol": "¤",
      "block": 3009048,
      "tx_id": 5,
      "mints": 0,
      "max_supply": "1000000000",
      "minted": "1000000000",
      "in_circulation": "1000000000",
      "divisibility": 8,
      "turbo": true,
      "timestamp": 1727898475,
      "etching_tx": "81972d23a9abaa1c6f0d96b7bccd9af905ff8a4f44ac50f2a62366f92e5a8efb",
      "commitment_tx": "3caae66d4c38c46f56f12571fc518bbb36ce3ec03a4e3b6c3ed44dbee9fa9630",
      "raw_data": "7b22656469637473223a5b5d2c2265746368696e67223a7b2264697669736962696c697479223a33382c227072656d696e65223a313030303030303030302c2272756e65223a224d4158444543494d414c5352554e45534f424947222c2273706163657273223a302c2273796d626f6c223a6e756c6c2c227465726d73223a6e756c6c2c22747572626f223a747275657d2c226d696e74223a6e756c6c2c22706f696e746572223a317d",
      "is_featured": false
    }
  ]
}

Status endpoint

Returns the last indexed block to assert the status of the service.\

GET/v1/status

Response

200

Sync status is returned

Body

application/json

height*integer (int64)

Height of the last indexed block

Example: 10

indexer*string

Example: "runes_index"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "height": 10,
    "indexer": "runes_index"
  }
]

Search Runes by name

This endpoint is used to search for Runes.\

GET/v1/runes/search

Query parameters

Response

200400500

Success

Body

application/json

recordsarray of Rune

Request

JavaScriptCurlPython

const response = await fetch('/v1/runes/search?s=BIG', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "records": [
    {
      "id": "3009048:5",
      "rune": "MAXDECIMALSRUNESOBIG",
      "display_name": "MAXDECIMALSRUNESOBIG",
      "symbol": "¤",
      "block": 3009048,
      "tx_id": 5,
      "mints": 0,
      "max_supply": "1000000000",
      "minted": "1000000000",
      "in_circulation": "1000000000",
      "divisibility": 8,
      "turbo": true,
      "timestamp": 1727898475,
      "etching_tx": "81972d23a9abaa1c6f0d96b7bccd9af905ff8a4f44ac50f2a62366f92e5a8efb",
      "commitment_tx": "3caae66d4c38c46f56f12571fc518bbb36ce3ec03a4e3b6c3ed44dbee9fa9630",
      "raw_data": "7b22656469637473223a5b5d2c2265746368696e67223a7b2264697669736962696c697479223a33382c227072656d696e65223a313030303030303030302c2272756e65223a224d4158444543494d414c5352554e45534f424947222c2273706163657273223a302c2273796d626f6c223a6e756c6c2c227465726d73223a6e756c6c2c22747572626f223a747275657d2c226d696e74223a6e756c6c2c22706f696e746572223a317d",
      "is_featured": false
    }
  ]
}

Get Rune by name

This endpoint is used to get a Rune by name.\

GET/v1/runes/{rune}

Path parameters

rune*Rune name

Response

200400500

Success

Body

application/json

idstring

block number : transaction number in that block

Example: "3009048:5"

runestring

Example: "MAXDECIMALSRUNESOBIG"

display_namestring

Example: "MAXDECIMALSRUNESOBIG"

symbolstring

A single UTF8 character, including emoji

Example: "¤"

blockinteger (int64)

Example: 3009048

tx_idinteger (int32)

A tx position in a block

Example: 5

mintsinteger (int32)

Example: 0

max_supplystring

Total amount of runes minted

Example: "1000000000"

mintedstring

Example: "1000000000"

in_circulationstring

Total amount of runes in circulation (max_supply - burned)

Example: "1000000000"

divisibilityinteger (int32)

Number of subunits in a super unit of runes

Example: 8

turboboolean

Example: true

timestampinteger (int64)

Example: 1727898475

etching_txstring

Example: "81972d23a9abaa1c6f0d96b7bccd9af905ff8a4f44ac50f2a62366f92e5a8efb"

commitment_txstring

Example: "3caae66d4c38c46f56f12571fc518bbb36ce3ec03a4e3b6c3ed44dbee9fa9630"

raw_datastring

a raw transaction hex

Example: "7b22656469637473223a5b5d2c2265746368696e67223a7b2264697669736962696c697479223a33382c227072656d696e65223a313030303030303030302c2272756e65223a224d4158444543494d414c5352554e45534f424947222c2273706163657273223a302c2273796d626f6c223a6e756c6c2c227465726d73223a6e756c6c2c22747572626f223a747275657d2c226d696e74223a6e756c6c2c22706f696e746572223a317d"

is_featuredboolean

Example: false

Request

JavaScriptCurlPython

const response = await fetch('/v1/runes/{rune}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "id": "3009048:5",
  "rune": "MAXDECIMALSRUNESOBIG",
  "display_name": "MAXDECIMALSRUNESOBIG",
  "symbol": "¤",
  "block": 3009048,
  "tx_id": 5,
  "mints": 0,
  "max_supply": "1000000000",
  "minted": "1000000000",
  "in_circulation": "1000000000",
  "divisibility": 8,
  "turbo": true,
  "timestamp": 1727898475,
  "etching_tx": "81972d23a9abaa1c6f0d96b7bccd9af905ff8a4f44ac50f2a62366f92e5a8efb",
  "commitment_tx": "3caae66d4c38c46f56f12571fc518bbb36ce3ec03a4e3b6c3ed44dbee9fa9630",
  "raw_data": "7b22656469637473223a5b5d2c2265746368696e67223a7b2264697669736962696c697479223a33382c227072656d696e65223a313030303030303030302c2272756e65223a224d4158444543494d414c5352554e45534f424947222c2273706163657273223a302c2273796d626f6c223a6e756c6c2c227465726d73223a6e756c6c2c22747572626f223a747275657d2c226d696e74223a6e756c6c2c22706f696e746572223a317d",
  "is_featured": false
}

Get Rune balance

This endpoint is used to get a Rune balance by address.\

GET/v1/runes/by-address/{address}/balance/{rune}

Path parameters

address*string

rune*string

BTC or rune name

Response

200400500

Success

Body

application/json

asset*Asset

address*string

Example: "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"

balance*string

Example: "1000000000"

Request

JavaScriptCurlPython

const response = await fetch('/v1/runes/by-address/{address}/balance/{rune}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "asset": {
    "name": "BTC",
    "display_name": "Bitcoin",
    "symbol": "B",
    "decimals": 8,
    "max_supply": "21000000000",
    "in_circulation": "21000000000"
  },
  "address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
  "balance": "1000000000"
}

List all balances of specific address

This endpoint is used to list balances of Runes by address.\

GET/v1/runes/by-address/{address}/balance

Path parameters

address*path

Response

200500

Success

Body

application/json

metaListResponseMeta

recordsarray of Balance

Request

JavaScriptCurlPython

const response = await fetch('/v1/runes/by-address/{address}/balance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": false,
    "total_records": 123
  },
  "records": [
    {
      "asset": {
        "name": "BTC",
        "display_name": "Bitcoin",
        "symbol": "B",
        "decimals": 8,
        "max_supply": "21000000000",
        "in_circulation": "21000000000"
      },
      "address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
      "balance": "1000000000"
    }
  ]
}

List UTXOs by asset and address

This endpoint is used to list UTXOs by asset and address.\

GET/v1/utxo/{asset}/{address}

Path parameters

asset*string

address*string

Query parameters

Response

200500

Success

Body

application/json

metaListResponseMeta

recordsarray of RuneUtxo

Request

JavaScriptCurlPython

const response = await fetch('/v1/utxo/{asset}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": false,
    "total_records": 123
  },
  "records": [
    {
      "id": 123,
      "block": 3009048,
      "tx_id": 1,
      "tx_hash": "af7ef135a4469ec63af59e7244693418fdb96e852baf84c0adb70b28d9ec99e1",
      "output_n": 0,
      "rune": "MAXDECIMALSRUNESOBIG",
      "address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
      "pk_script": "76a914c0e3d9d0c2f0a5e2a0d6a9e1f3c5f6e8c8d7d88ac",
      "amount": "1000000000",
      "btc_amount": 600,
      "spend": false
    }
  ]
}

Get BTC balance by address

This endpoint is used to get a BTC balance by address.\

GET/v1/btc/balance/{address}

Path parameters

address*string

Example: "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"

Response

200500

Success

Body

application/json

addressstring

Example: "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"

balanceinteger (uint64)

Request

JavaScriptCurlPython

const response = await fetch('/v1/btc/balance/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "address": "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"
}

Get list of Trading Pairs

This endpoint is used to get a list of trading pairs.\

GET/v1/pairs

Query parameters

Response

200500

Success

Body

application/json

metaListResponseMeta

recordsarray of TradingPairWithMarketData

Request

JavaScriptCurlPython

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

Response

200500

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": false,
    "total_records": 123
  },
  "records": [
    {
      "base_asset": {
        "name": "BTC",
        "display_name": "Bitcoin",
        "symbol": "B",
        "decimals": 8,
        "max_supply": "21000000000",
        "in_circulation": "21000000000"
      },
      "quote_asset": {
        "name": "BTC",
        "display_name": "Bitcoin",
        "symbol": "B",
        "decimals": 8,
        "max_supply": "21000000000",
        "in_circulation": "21000000000"
      },
      "base_amount": "1279361",
      "quote_amount": "35200000",
      "rate": "3634548.2954545454545454545",
      "id": 2,
      "pool_address": "tb1pptp2yfl3xjvltfxwwvqnsspe60uyc0a24d90ymas4qxl8xs8rxss94quj9",
      "price_btc": "2.751373537258053043668E-7",
      "price_sat": "7.51373537258053043668",
      "price_usd": "0.0170889585035029197178120051",
      "btcisd_price": "62110.64",
      "market_cap": "17088958.50",
      "fdv": "17088958.50",
      "tvl": "43725.89",
      "done_swap_count": 3,
      "base_1d_volume": "1279361",
      "quote_1d_volume": "35200000"
    }
  ]
}

Create Trading Pair

This endpoint is used to create a new trading pair. Idempotent. If pair exists, returns existing pool address.

POST/v1/pairs/create

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Body

application/json

base_asset*string

Example: "BTC"

quote_asset*string

Example: "MYLOVELYRUNE"

Response

200400404500

Success

Body

application/json

idinteger (int64)

Example: 2

pool_addressstring

Example: "tb1pptp2yfl3xjvltfxwwvqnsspe60uyc0a24d90ymas4qxl8xs8rxss94quj9"

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "base_asset": "BTC",
      "quote_asset": "MYLOVELYRUNE"
    }),
});
const data = await response.json();

Response

200400404500

{
  "id": 2,
  "pool_address": "tb1pptp2yfl3xjvltfxwwvqnsspe60uyc0a24d90ymas4qxl8xs8rxss94quj9"
}

Get Trading Pair

This endpoint is used to get a trading pair.

GET/v1/pairs/{base}-{quote}

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Response

200400404500

Success

Body

application/json

base_assetAsset

quote_assetAsset

base_amountstring

Example: "1279361"

quote_amountstring

Example: "35200000"

ratestring

base_amount / quote_amount

Example: "3634548.2954545454545454545"

idinteger (int64)

Example: 2

pool_addressstring

Example: "tb1pptp2yfl3xjvltfxwwvqnsspe60uyc0a24d90ymas4qxl8xs8rxss94quj9"

price_btcstring

Example: "2.751373537258053043668E-7"

price_satstring

Example: "7.51373537258053043668"

price_usdstring

Example: "0.0170889585035029197178120051"

btcisd_pricestring

Example: "62110.64"

market_capstring

in USD

Example: "17088958.50"

fdvstring

in USD

Example: "17088958.50"

tvlstring

in USD

Example: "43725.89"

done_swap_countinteger (int64)

number of finalized swaps in this pool (buy+sell)

Example: 3

base_1d_volumestring

in base units

Example: "1279361"

quote_1d_volumestring

in quote units

Example: "35200000"

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "base_asset": {
    "name": "BTC",
    "display_name": "Bitcoin",
    "symbol": "B",
    "decimals": 8,
    "max_supply": "21000000000",
    "in_circulation": "21000000000"
  },
  "quote_asset": {
    "name": "BTC",
    "display_name": "Bitcoin",
    "symbol": "B",
    "decimals": 8,
    "max_supply": "21000000000",
    "in_circulation": "21000000000"
  },
  "base_amount": "1279361",
  "quote_amount": "35200000",
  "rate": "3634548.2954545454545454545",
  "id": 2,
  "pool_address": "tb1pptp2yfl3xjvltfxwwvqnsspe60uyc0a24d90ymas4qxl8xs8rxss94quj9",
  "price_btc": "2.751373537258053043668E-7",
  "price_sat": "7.51373537258053043668",
  "price_usd": "0.0170889585035029197178120051",
  "btcisd_price": "62110.64",
  "market_cap": "17088958.50",
  "fdv": "17088958.50",
  "tvl": "43725.89",
  "done_swap_count": 3,
  "base_1d_volume": "1279361",
  "quote_1d_volume": "35200000"
}

Get Address Position

This endpoint is used to get the position of an address in a trading pair.\

GET/v1/pairs/{base}-{quote}/address-position/{address}

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

address*string

Example: "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"

Response

200500

Success

Body

application/json

trading_pairinteger (int64)

Example: 2

base_assetAsset

pool_sharestring

Example: "0.153"

user_locked_value_usdstring

Example: "1223123.23"

earningsstring

Example: "333.33"

base_value_usdstring

Example: "1223123.23"

quote_value_usdstring

Example: "1223123.23"

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/address-position/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "trading_pair": 2,
  "base_asset": {
    "name": "BTC",
    "display_name": "Bitcoin",
    "symbol": "B",
    "decimals": 8,
    "max_supply": "21000000000",
    "in_circulation": "21000000000"
  },
  "pool_share": "0.153",
  "user_locked_value_usd": "1223123.23",
  "earnings": "333.33",
  "base_value_usd": "1223123.23",
  "quote_value_usd": "1223123.23"
}

Add Liquidity

This endpoint is used to add liquidity to a trading pair.\

POST/v1/pairs/{base}-{quote}/add-liquidity

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Body

application/json

base_address*string

Example: "bc1pkr9xwf5n6ugue9ra4p3quy940gl3qaaju57pvvhy5xh8xehmzh3syzdqs3"

base_address_pubkeynullable string

Example: "8f0f508a694fe6991fd6fd8be19bfec9dad34afbc5e16c2c6af1b57ee4a75f28"

base_amount*string

Example: "41533"

quote_address*string

Example: "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC"

quote_address_pubkeynullable string

Example: "02c64921f5c9b2c209ada61c78719eec30bebcdfc1d63ee051a68aa241ffb3190a"

quote_amount*string

Example: "10000"

Response

200400404500

Success

Body

application/json

request_idstring

Example: "123"

pair_idinteger (int64)

Example: 2

pairstring

Example: "BTC/MYLOVELYRUNE"

base_addressstring

Example: "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"

quote_addressstring

Example: "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC"

base_amountstring

Example: "41533"

quote_amountstring

Example: "10000"

btc_tx_feeinteger (int64)

Example: 1000

psbtstring

partially signed bitcoin transaction

raw_txstring

base_inputsarray of integer (uint64)

quote_inputsarray of integer (uint64)

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/add-liquidity', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "base_address": "bc1pkr9xwf5n6ugue9ra4p3quy940gl3qaaju57pvvhy5xh8xehmzh3syzdqs3",
      "base_amount": "41533",
      "quote_address": "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC",
      "quote_amount": "10000"
    }),
});
const data = await response.json();

Response

200400404500

{
  "request_id": "123",
  "pair_id": 2,
  "pair": "BTC/MYLOVELYRUNE",
  "base_address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
  "quote_address": "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC",
  "base_amount": "41533",
  "quote_amount": "10000",
  "btc_tx_fee": 1000,
  "psbt": "text",
  "raw_tx": "text",
  "base_inputs": [],
  "quote_inputs": []
}

Calculate

This endpoint is used to calculate the base and quote amounts.\

GET/v1/pairs/{base}-{quote}/calculate

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Response

200400404500

Success

Body

application/json

basestring

Example: "1000"

quotestring

Example: "10000"

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/calculate', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "base": "1000",
  "quote": "10000"
}

Swap

This endpoint is used to swap assets in a trading pair.\

POST/v1/pairs/{base}-{quote}/swap

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Body

application/json

ask_address*string

ask_amount*string

bid_address*string

bid_address_pubkeynullable string

bid_amount*string

bid_asset*string

fee_address*string

fee_address_pubkeynullable string

rate*string

slippage*number (double)

slippage_tolerance*boolean

Response

200400404500

Success

Body

application/json

request_idstring

Example: "123"

pair_idinteger (int64)

Example: 2

pairstring

Example: "BTC/MYLOVELYRUNE"

base_addressstring

Example: "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"

quote_addressstring

Example: "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC"

base_amountstring

Example: "41533"

quote_amountstring

Example: "10000"

btc_tx_feeinteger (int64)

Example: 1000

psbtstring

partially signed bitcoin transaction

raw_txstring

base_inputsarray of integer (uint64)

quote_inputsarray of integer (uint64)

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/swap', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ask_address": "text",
      "ask_amount": "text",
      "bid_address": "text",
      "bid_amount": "text",
      "bid_asset": "text",
      "fee_address": "text",
      "rate": "text",
      "slippage": 0,
      "slippage_tolerance": false
    }),
});
const data = await response.json();

Response

200400404500

{
  "request_id": "123",
  "pair_id": 2,
  "pair": "BTC/MYLOVELYRUNE",
  "base_address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
  "quote_address": "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC",
  "base_amount": "41533",
  "quote_amount": "10000",
  "btc_tx_fee": 1000,
  "psbt": "text",
  "raw_tx": "text",
  "base_inputs": [],
  "quote_inputs": []
}

Remove Liquidity

This endpoint is used to remove liquidity from a trading pair.\

POST/v1/pairs/{base}-{quote}/remove-liquidity

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Body

application/json

base_address*string

base_amount*string

fee_address*string

fee_address_pubkeynullable string

quote_address*string

quote_amount*string

Response

200400404500

Success

Body

application/json

request_idstring

Example: "123"

pair_idinteger (int64)

Example: 2

pairstring

Example: "BTC/MYLOVELYRUNE"

base_addressstring

Example: "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"

quote_addressstring

Example: "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC"

base_amountstring

Example: "41533"

quote_amountstring

Example: "10000"

btc_tx_feeinteger (int64)

Example: 1000

psbtstring

partially signed bitcoin transaction

raw_txstring

base_inputsarray of integer (uint64)

quote_inputsarray of integer (uint64)

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/remove-liquidity', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "base_address": "text",
      "base_amount": "text",
      "fee_address": "text",
      "quote_address": "text",
      "quote_amount": "text"
    }),
});
const data = await response.json();

Response

200400404500

{
  "request_id": "123",
  "pair_id": 2,
  "pair": "BTC/MYLOVELYRUNE",
  "base_address": "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f",
  "quote_address": "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC",
  "base_amount": "41533",
  "quote_amount": "10000",
  "btc_tx_fee": 1000,
  "psbt": "text",
  "raw_tx": "text",
  "base_inputs": [],
  "quote_inputs": []
}

Get Trading Pair Price History

This endpoint is used to get the price history of a trading pair.\

GET/v1/pairs/{base}-{quote}/price-history

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Query parameters

Response

200400404500

Gapfilled candlestick data

Body

application/json

itemsCandlestickData

Serialized as an array of fields (9 elements).

Fields: [start_time, trading_pair_id, open, close, high, low, base_volume, quote_volume, count]

All points are gapfilled - meaning that even if database contains 0 trades in range [start_time...end_time], but there were trades before start_time, then returned array will contain (end_time - start_time) points (with interval between them).

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/price-history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

[
  [
    "2023-07-09T07:46:40",
    0,
    "100",
    "101",
    "102",
    "103",
    "1000",
    "102000",
    5
  ]
]

Get Trading Pair Swap History

This endpoint is used to get the swap history of a trading pair.\

GET/v1/pairs/{base}-{quote}/swap-history

Path parameters

base*string

Example: "BTC"

quote*string

Example: "MYLOVELYRUNE"

Query parameters

Response

200400404500

Success

Body

application/json

metaListResponseMeta

recordsarray of Swap

Request

JavaScriptCurlPython

const response = await fetch('/v1/pairs/{base}-{quote}/swap-history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": false,
    "total_records": 123
  },
  "records": [
    {
      "time": "2024-11-16T02:20:09.479Z",
      "side": "buy",
      "base_amount": "1000",
      "quote_amount": "10000",
      "price_btc": "0.001",
      "btcusd_price": "1000"
    }
  ]
}

Submit Transaction

This endpoint allows to submit a transaction to the Bitcoin network.\

POST/v1/publish-tx

Body

application/json

contextnullable string

psbt*string

request_idnullable string

Response

200400

Success

Body

application/json

tx_idstring

Example: "af7ef135a4469ec63af59e7244693418fdb96e852baf84c0adb70b28d9ec99e1"

statusenum

Example: "pending"

pendingminedfailed

Request

JavaScriptCurlPython

const response = await fetch('/v1/publish-tx', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "psbt": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "tx_id": "af7ef135a4469ec63af59e7244693418fdb96e852baf84c0adb70b28d9ec99e1",
  "status": "pending"
}

Get User Liquidity

This endpoint is used to get a user's liquidity positions.\

GET/v1/users/{address}/liquidity

Path parameters

address*string

Example: "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"

Response

200500

Success

Body

application/json

trading_pairinteger (int64)

Example: 2

base_assetAsset

pool_sharestring

Example: "0.153"

user_locked_value_usdstring

Example: "1223123.23"

earningsstring

Example: "333.33"

base_value_usdstring

Example: "1223123.23"

quote_value_usdstring

Example: "1223123.23"

Request

JavaScriptCurlPython

const response = await fetch('/v1/users/{address}/liquidity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "trading_pair": 2,
    "base_asset": {
      "name": "BTC",
      "display_name": "Bitcoin",
      "symbol": "B",
      "decimals": 8,
      "max_supply": "21000000000",
      "in_circulation": "21000000000"
    },
    "pool_share": "0.153",
    "user_locked_value_usd": "1223123.23",
    "earnings": "333.33",
    "base_value_usd": "1223123.23",
    "quote_value_usd": "1223123.23"
  }
]

Get user

This endpoint is used to get a user from the database.\

GET/v1/users/{address}

Path parameters

address*string

Example: "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw"

Response

200500

List of addresses

Body

application/json

itemsstring

Example: "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"

Request

JavaScriptCurlPython

const response = await fetch('/v1/users/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"
]

Add a new user

This endpoint is used to add a new user to the database.\

POST/v1/users

Body

application/json

addresses*array of string

terms*boolean

wallet_type*string

Response

200500

Success

Body

application/json

user_idstring (integer)

Request

JavaScriptCurlPython

const response = await fetch('/v1/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "addresses": [
        "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"
      ],
      "terms": false,
      "wallet_type": "text"
    }),
});
const data = await response.json();

Response

200500

{
  "user_id": "text"
}