Ctrlk
Swap On Nexus
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Records

This page documents record-related APIs for single-sided pools, including current assets/status and historical records.

API Scope

  • Manage single-sided pool pairs: /api/pool/single/manage_list

  • Single-sided pool total assets: /api/pool/single/total_assets

  • Current pool list and status: /api/pool/single/pool_list

  • Single-sided pool operation history: /api/pool/single/pool_history

  • Single-sided pool swap history: /api/pool/single/swap_history

Current Assets and Status

Managed Liquidity Pool List

post
Body
apy_metricstringRequired
Responses
200Success
application/json
codeintegerRequired
msgstringRequired
post/api/pool/single/manage_list
POST /api/pool/single/manage_list HTTP/1.1
Host: 127.0.0.1:8090
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "payer_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  },
  "payer_asset_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  }
}
200Success
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 1,
    "items": [
      {
        "token": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick1": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick2": {
          "tick": "USDC•STARKNET•TEST",
          "token_id": "62",
          "coin_type": "runes"
        },
        "tick1_amount": 1000,
        "tick2_amount": 5000,
        "total_tick1_fee_income": 2000,
        "total_tick2_fee_income": 3000,
        "apr": 0.01
      }
    ]
  }
}

Trade Settlement Total Assets

post
Body
Responses
200Success
application/json
codeintegerRequired
msgstringRequired
post/api/pool/single/total_assets
POST /api/pool/single/total_assets HTTP/1.1
Host: 127.0.0.1:8090
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "payer_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  },
  "payer_asset_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  }
}
200Success
{
  "code": 0,
  "msg": "sed proident",
  "data": {
    "total": 1,
    "items": [
      {
        "tick": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "wallet_balance": 1000,
        "market_maker_balance": "1000",
        "wallet_balance_stat_points": [
          {
            "balance": 69,
            "record_time": "1987-06-29 01:58:34"
          },
          {
            "balance": 62,
            "record_time": "1985-06-15 09:00:54"
          }
        ]
      }
    ]
  }
}

Joint Market-Making Pool List

post
Body
Responses
200Success
application/json
codeintegerRequired
msgstringRequired
post/api/pool/single/pool_list
POST /api/pool/single/pool_list HTTP/1.1
Host: 127.0.0.1:8090
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "payer_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  },
  "payer_asset_address": {
    "address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
    "public_key": "03786f146fa5031d05f5e81a2e983a6747f4444762e90b717b15633e9e043a16b9"
  }
}
200Success
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 1,
    "items": [
      {
        "token": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick1": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick2": {
          "tick": "USDC•STARKNET•TEST",
          "token_id": "118799:33",
          "coin_type": "runes"
        },
        "tick1_amount": 39,
        "tick2_amount": 76,
        "lp_fee_per": "0.01",
        "dotswap_fee_per": "0.001",
        "total_tick1_fee_income": 73,
        "total_tick2_fee_income": 41,
        "apy": 0,
        "apr_1d": "0.001",
        "apr_7d": "0.002",
        "apr_30d": "0.003",
        "status": "MATCHING",
        "time_ms": 1040204313565,
        "min_amount": 100,
        "max_amount": 500,
        "min_fee_rate": 0.05,
        "pool_id": "50001",
        "tx_id": "",
        "price_tick_lower": 80000,
        "price_tick_upper": 110000,
        "unit_tick": "BTC",
        "matched_price_tick_lower": 80000,
        "matched_price_tick_upper": 110000
      }
    ]
  }
}

Historical Records

Pool History

post
Body
pageintegerRequired
page_sizeintegerRequired
typestringRequired

Operation type

statusstringRequired

Status (Pending | Success | Failed | Rollback)

start_timeintegerRequired
end_timeintegerRequired
pool_idstringRequired
Responses
200Success
application/json
codeintegerRequired
msgstringRequired
post/api/pool/single/pool_history
POST /api/pool/single/pool_history HTTP/1.1
Host: 127.0.0.1:8090
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "page": 1,
  "page_size": 10,
  "type": "ADD",
  "status": "Success",
  "start_time": 644086048665,
  "end_time": 1387294738384,
  "pool_id": "50001"
}
200Success
{
  "code": 0,
  "msg": "sunt officia dolore quis aliqua",
  "data": {
    "total": 49,
    "items": [
      {
        "pool_id": "26",
        "type": "ADD",
        "token": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick1": {
          "tick": "BTC",
          "token_id": "",
          "coin_type": "btc"
        },
        "tick2": {
          "tick": "USDC•STARKNET•TEST",
          "token_id": "118799:33",
          "coin_type": "runes"
        },
        "btc_price": "100000",
        "wallet_balance_before_a": "81",
        "wallet_balance_before_b": "45",
        "wallet_balance_after_a": "18",
        "wallet_balance_after_b": "95",
        "pool_tokens_before_a": "1000",
        "pool_tokens_before_b": "100",
        "pool_tokens_after_a": "1100",
        "pool_tokens_after_b": "110",
        "your_pool_tokens_before_a": "500",
        "your_pool_tokens_before_b": "100",
        "your_pool_tokens_after_a": "600",
        "your_pool_tokens_after_b": "200",
        "status": "Success",
        "time_ms": 657114559444,
        "tx_id": "",
        "order_address": "tb1pf0tcpgxr30kqhh2gn3pgvr4qyachzm0xxydnfxth5cxlkjl37ugspxp7tm",
        "min_amount": 2000,
        "max_amount": 50000,
        "min_fee_rate": 0.001,
        "price_tick_lower": 80000,
        "price_tick_upper": 110000,
        "unit_tick": "BTC",
        "matched_price_tick_lower": 80000,
        "matched_price_tick_upper": 110000
      }
    ]
  }
}

Trade History

post
Body
pageintegerRequired
page_sizeintegerRequired
channelstringRequired

Channel

statusstringRequired

Status (Pending | Success | Failed | Rollback)

start_timeintegerRequired
end_timeintegerRequired
pool_idintegerOptional
Responses
200Success
application/json
codeintegerRequired
msgstringRequired
post/api/pool/single/swap_history
POST /api/pool/single/swap_history HTTP/1.1
Host: 127.0.0.1:8090
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "page": 1,
  "page_size": 10,
  "channel": "XVERSE",
  "status": "Success",
  "start_time": 107246701519,
  "end_time": 1005951575679,
  "pool_id": 50001
}
200Success
{
  "code": 1,
  "msg": "text",
  "data": {
    "items": [
      {
        "settle_method": "wallet",
        "protocol": "text",
        "op": "text",
        "tick1": "text",
        "tick1_amount": "text",
        "tick1_order_total_amount": "text",
        "tick2": "text",
        "tick2_amount": "text",
        "tick2_order_total_amount": "text",
        "time_ms": "text",
        "status": "Pending",
        "revenue": "text",
        "channel": "text",
        "average_price": "text",
        "platform_fee": "text",
        "btc_price_usd": "text",
        "benchmark_token": "text",
        "settlement_address": "text",
        "taker_fee": "text",
        "tvl_before_swap": "text",
        "tvl_after_swap": "text",
        "single_side_from_balance_before_swap": "text",
        "single_side_to_balance_before_swap": "text",
        "single_side_from_balance_after_swap": "text",
        "single_side_to_balance_after_swap": "text",
        "single_side_tick_a_fee_income": "text",
        "single_side_tick_b_fee_income": "text",
        "from_balance_before_swap": "text",
        "to_balance_before_swap": "text",
        "from_balance_after_swap": "text",
        "to_balance_after_swap": "text",
        "address": "text",
        "pool_id": "text"
      }
    ],
    "total": 1
  }
}
PreviousManage PoolNextTaker

Last updated