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

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/healthcheck'

200

200

No body

Ok Status

Version endpoint

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

get

/v1/version

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/version'

200

200

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

App Info

List known runes

This endpoint is used to list known runes.

get

/v1/runes

Query parameters

namestring | nullable

Filter by rune name as %NAME%. "SUPER" will match "MYSUPERRUNE", for example.

Example: SUPER

exists_in_pool_with_liquidityboolean | nullable

Specify true for pairs with liquidity, false for pairs without, or omit for all pairs.

featuredboolean | nullable

Will return only featured runes.

limitinteger · int32 | nullable

Number of runes to return.

pageinteger · int32 | nullable

Page number for pagination.

orderstring · enum | nullable

Order of the results.

Example: ASC

Options: ASC, DESC

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/runes'

200

400

500

200

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": true,
    "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
    }
  ]
}

List of matched runes

Status endpoint

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

get

/v1/status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/status'

200

200

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

Sync status is returned

Search Runes by name

This endpoint is used to search for Runes.\

get

/v1/runes/search

Query parameters

sstringrequired

Example: BIG

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/runes/search?s=BIG'

200

400

500

200

{
  "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
    }
  ]
}

Success

Get Rune by name

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

get

/v1/runes/{rune}

Path parameters

runestringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/runes/{rune}'

200

400

500

200

{
  "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
}

Success

Get Rune balance

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

get

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

Path parameters

addressstringrequired

runestringrequired

BTC or rune name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/runes/by-address/{address}/balance/{rune}'

200

400

500

200

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

Success

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

addressstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/runes/by-address/{address}/balance'

200

500

200

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

Success

List UTXOs by asset and address

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

get

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

Path parameters

assetstringrequired

addressstringrequired

Query parameters

limitinteger · int32 | nullable

Number of runes to return.

namestring | nullable

Filter by rune name as %NAME%. "SUPER" will match "MYSUPERRUNE", for example.

Example: SUPER

orderstring · enum | nullable

Order of the results.

Example: ASC

Options: ASC, DESC

pageinteger · int32 | nullable

Page number for pagination.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/utxo/{asset}/{address}'

200

500

200

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": true,
    "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
    }
  ]
}

Success

Get BTC balance by address

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

get

/v1/btc/balance/{address}

Path parameters

addressstringrequired

Example: tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/btc/balance/{address}'

200

500

200

{
  "address": "tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw",
  "balance": 1
}

Success

Get list of Trading Pairs

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

get

/v1/pairs

Query parameters

limitinteger · int32 | nullable

Number of runes to return.

namestring | nullable

Filter by rune name as %NAME%. "SUPER" will match "MYSUPERRUNE", for example.

Example: SUPER

orderstring · enum | nullable

Order of the results.

Example: ASC

Options: ASC, DESC

pageinteger · int32 | nullable

Page number for pagination.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs'

200

500

200

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": true,
    "total_records": 123
  },
  "records": [
    {
      "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",
      "base_asset": {
        "name": "BTC",
        "display_name": "Bitcoin",
        "symbol": "B",
        "decimals": 8,
        "max_supply": "21000000000",
        "in_circulation": "21000000000"
      },
      "quote_asset": {
        "name": "THISISZERODECIMALRUNE",
        "display_name": "THISISZERODECIMALRUNE",
        "symbol": "¤",
        "decimals": 0,
        "max_supply": "1000000000",
        "in_circulation": "1000000000"
      }
    }
  ]
}

Success

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

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Body

base_assetstringrequired

Example: BTC

quote_assetstringrequired

Example: MYLOVELYRUNE

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/pairs/create' \
  --header 'Content-Type: application/json' \
  --data '{
    "base_asset": "BTC",
    "quote_asset": "MYLOVELYRUNE"
  }'

200

400

404

500

200

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

Success

Get Trading Pair

This endpoint is used to get a trading pair.

get

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

Path parameters

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs/{base}-{quote}'

200

400

404

500

200

{
  "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",
  "base_asset": {
    "name": "BTC",
    "display_name": "Bitcoin",
    "symbol": "B",
    "decimals": 8,
    "max_supply": "21000000000",
    "in_circulation": "21000000000"
  },
  "quote_asset": {
    "name": "THISISZERODECIMALRUNE",
    "display_name": "THISISZERODECIMALRUNE",
    "symbol": "¤",
    "decimals": 0,
    "max_supply": "1000000000",
    "in_circulation": "1000000000"
  }
}

Success

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

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

addressstringrequired

Example: tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs/{base}-{quote}/address-position/{address}'

200

500

200

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

Success

Add Liquidity

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

post

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

Path parameters

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Body

base_addressstringrequired

Example: bc1pkr9xwf5n6ugue9ra4p3quy940gl3qaaju57pvvhy5xh8xehmzh3syzdqs3

base_address_pubkeystring | nullable

Example: 8f0f508a694fe6991fd6fd8be19bfec9dad34afbc5e16c2c6af1b57ee4a75f28

base_amountstringrequired

Example: 41533

quote_addressstringrequired

Example: 37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC

quote_address_pubkeystring | nullable

Example: 02c64921f5c9b2c209ada61c78719eec30bebcdfc1d63ee051a68aa241ffb3190a

quote_amountstringrequired

Example: 10000

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/pairs/{base}-{quote}/add-liquidity' \
  --header 'Content-Type: application/json' \
  --data '{
    "base_address": "bc1pkr9xwf5n6ugue9ra4p3quy940gl3qaaju57pvvhy5xh8xehmzh3syzdqs3",
    "base_address_pubkey": "8f0f508a694fe6991fd6fd8be19bfec9dad34afbc5e16c2c6af1b57ee4a75f28",
    "base_amount": "41533",
    "quote_address": "37LHryP6Pj6Z98bQZj76YBcQ1JNKZsSXoC",
    "quote_address_pubkey": "02c64921f5c9b2c209ada61c78719eec30bebcdfc1d63ee051a68aa241ffb3190a",
    "quote_amount": "10000"
  }'

200

400

404

500

200

{
  "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": [
    1
  ],
  "quote_inputs": [
    1
  ]
}

Success

Calculate

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

get

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

Path parameters

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Query parameters

basestring

Example: BTC

quotestring

Example: MYLOVELYRUNE

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs/{base}-{quote}/calculate'

200

400

404

500

200

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

Success

Swap

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

post

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

Path parameters

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Body

ask_addressstringrequired

ask_amountstringrequired

bid_addressstringrequired

bid_address_pubkeystring | nullable

bid_amountstringrequired

bid_assetstringrequired

fee_addressstringrequired

fee_address_pubkeystring | nullable

ratestringrequired

slippagenumber · doublerequired

slippage_tolerancebooleanrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/pairs/{base}-{quote}/swap' \
  --header 'Content-Type: application/json' \
  --data '{
    "ask_address": "text",
    "ask_amount": "text",
    "bid_address": "text",
    "bid_address_pubkey": "text",
    "bid_amount": "text",
    "bid_asset": "text",
    "fee_address": "text",
    "fee_address_pubkey": "text",
    "rate": "text",
    "slippage": 1,
    "slippage_tolerance": true
  }'

200

400

404

500

200

{
  "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": [
    1
  ],
  "quote_inputs": [
    1
  ]
}

Success

Remove Liquidity

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

post

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

Path parameters

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Body

base_addressstringrequired

base_amountstringrequired

fee_addressstringrequired

fee_address_pubkeystring | nullable

quote_addressstringrequired

quote_amountstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/pairs/{base}-{quote}/remove-liquidity' \
  --header 'Content-Type: application/json' \
  --data '{
    "base_address": "text",
    "base_amount": "text",
    "fee_address": "text",
    "fee_address_pubkey": "text",
    "quote_address": "text",
    "quote_amount": "text"
  }'

200

400

404

500

200

{
  "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": [
    1
  ],
  "quote_inputs": [
    1
  ]
}

Success

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

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Query parameters

start_timestring · partial-date-time | nullable

end_timestring · partial-date-time | nullable

limitinteger · int32 · min: 1 · max: 1000

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs/{base}-{quote}/price-history'

200

400

404

500

200

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

Gapfilled candlestick data

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

basestringrequired

Example: BTC

quotestringrequired

Example: MYLOVELYRUNE

Query parameters

orderstring · enum | nullable

Order of the results.

Example: ASC

Options: ASC, DESC

limitinteger · int32 | nullable

Number of runes to return.

pageinteger · int32 | nullable

Page number for pagination.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/pairs/{base}-{quote}/swap-history'

200

400

404

500

200

{
  "meta": {
    "page": 0,
    "limit": 50,
    "offset": 0,
    "has_more": true,
    "total_records": 123
  },
  "records": [
    {
      "time": "2025-02-28T07:33:51.653Z",
      "trading_pair_id": 1,
      "base_amount": "1000",
      "quote_amount": "10000",
      "price_btc": "0.001",
      "btcusd_price": "1000",
      "side": "buy"
    }
  ]
}

Success

Submit Transaction

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

post

/v1/publish-tx

Body

contextstring | nullable

psbtstringrequired

request_idstring | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/publish-tx' \
  --header 'Content-Type: application/json' \
  --data '{
    "context": "text",
    "psbt": "text",
    "request_id": "text"
  }'

200

400

200

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

Success

Get User Liquidity

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

get

/v1/users/{address}/liquidity

Path parameters

addressstringrequired

Example: tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/users/{address}/liquidity'

200

500

200

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

Success

Get user

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

get

/v1/users/{address}

Path parameters

addressstringrequired

Example: tb1ps07g3t8hctex0ula3jaxxa85dqw28ewl0krmnt8mlpxukmzp9zeqmzjfdw

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/users/{address}'

200

500

200

[
  "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"
]

List of addresses

Add a new user

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

post

/v1/users

Body

termsbooleanrequired

wallet_typestringrequired

addressesstring[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "terms": true,
    "wallet_type": "text",
    "addresses": [
      "bc1p0x6psjqeawtw8zvekup2gcg8uuwejhgjfad3sp9xklmpeaq80m4qd0ly9f"
    ]
  }'

200

500

200

{
  "user_id": "text"
}

Success