Get Token List

Search all tokens

post
Header parameters
AuthorizationstringOptional

token

User-IdstringOptional
Body
pageintegerRequired
page_sizeintegerRequired
keywordstringOptional
addressstringOptional
usetypestringRequired

deposit/liquid/swap/gettick2/withdraw

tick1stringOptional
coin_typestringRequired
Responses
200
Success
application/json
post
POST /brc20swap/search_ticks HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "page": 1,
  "page_size": 30,
  "usetype": "liquid",
  "coin_type": "runes"
}
{
  "code": 0,
  "msg": "",
  "data": {
    "total": 1,
    "items": [
      {
        "tick": "SHE•SHE•SHE•SHE•SHE",
        "coin_type": "runes",
        "icon": "S",
        "holder_count": 2,
        "mint_percent": "0",
        "balance": "",
        "divisibility": 0,
        "non_removable": false,
        "tick_id": ""
      }
    ],
    "has_next": false
  },
  "req_id": "1887716234576175104"
}

Used to get the list of available tokens for swapping, adding liquidity, etc.

Swapping

Used for swapping tokens.

Get the complete list of tokens available for swapping, i.e., all tokens that have liquidity pools.

  • usetype: Use swap.

Note: Only tokens with injected liquidity pools can be swapped.

Example

{
    "page": 1,
    "page_size": 30,
    "keyword": "",
    "usetype": "swap",
    "coin_type": "runes"
}

Swappable Tokens

Used to get the list of all tokens swappable with a selected token (tick1).

  • tick1: The name of the selected token.

  • usetype: Use gettick2.

Example

{
    "page": 1,
    "page_size": 30,
    "keyword": "",
    "usetype": "gettick2",
    "coin_type": "runes",
    "tick1": "BTC"
}

Adding Liquidity

Used to get the list of all tokens available for adding liquidity.

  • usetype: Use liquid.

Example

{
    "page": 1,
    "page_size": 30,
    "keyword": "", 
    "address": "",
    "usetype": "liquid",  
    "coin_type": "runes"
}

Important Notes:

The query interface for RUNES, BRC20, and ARC20 is the same; only the coin_type is different.

Last updated