Pool Trade Event

Retrieve the trading history of a specific liquidity pool, with pagination support.


Endpoint

GET /api/v1/partner/pool/event/trade

Request Parameters

Name
Type
Required
Description

pool_address

string

No

The address of the liquidity pool.

protocols

string

No

Comma-separated list of protocol identifiers (e.g., cetus-clmm,aftermath-cpmm). Maximum 20 protocols per request.

limit

int

No

Number of records to return (default: 20, max: see backend config).

desc

bool

No

Fetch order: true for descending (default), false for ascending.

cursor

int64

No

Cursor for pagination.

timestamp

int64

No

Deprecated: Timestamp for pagination.

from

int64

No

Start time filter (Unix millisecond timestamp). Must be used with to.

to

int64

No

End time filter (Unix millisecond timestamp). Must be used with from.

from_checkpoint

int64

No

Start checkpoint filter. Must be used with to_checkpoint.

to_checkpoint

int64

No

End checkpoint filter. Must be used with from_checkpoint.

List of Supported Protocols

See Pool Data Supported Protocolarrow-up-right for the complete list of protocol identifiers and their names.

Pagination Notes:

  • If desc=false, cursor must be provided.

  • If desc=true, cursor can be omitted for the first page.

  • If you want to fetch the latest events, you can omit cursor, just provide pool_address and limit.

  • If you want to fetch the next page, you must provide cursor.

  • If you want to fetch the previous page, you must provide cursor with desc=false.

Filter Notes:

  • Time Range: Both from and to must be provided together. Maximum range is 60 days.

  • Checkpoint Range: Both from_checkpoint and to_checkpoint must be provided together. Maximum range is 2 million checkpoints.

  • Time and checkpoint filters can be used independently or together with other parameters.


Headers

Header
Required
Description

x-api-key

No

API key for authorization.


cURL Examples

Get Trade Events

Filter by Time Range

Filter by Checkpoint Range

Filter by Protocols

Filter by Protocols with Time Range


Response

Fields

Field
Type
Nullable
Description

code

number

No

HTTP status code (200 for success).

message

string

No

Status message.

data

array

No

Array of trade history objects.

pagination

object

No

Pagination info for next page.

Trade History Object

Field
Type
Nullable
Description

id

int64

No

Unique trade event ID.

timestamp

int64

No

Event timestamp (ms since epoch).

action

string

No

Event type (e.g., trade).

pool_address

string

No

Pool address.

coin_a_type

string

No

Coin A type.

coin_b_type

string

No

Coin B type.

coin_a_symbol

string

No

Coin A symbol.

coin_b_symbol

string

No

Coin B symbol.

price

float

No

Trade price.

amount_a

float

No

Amount of coin A.

amount_b

float

No

Amount of coin B.

amount_a_usd

float

No

USD value of amount A.

amount_b_usd

float

No

USD value of amount B.

a_to_b

bool

No

Trade direction: true if A to B.

tx_digest

string

No

Transaction digest.

sender

string

No

Sender address.

source

string

Yes

Source DEX name (may be null).

Pagination Object

Field
Type
Nullable
Description

last_cursor

int64

Yes

Cursor for next page.

last_timestamp

int64

Yes

Deprecated: Timestamp for next page.

limit

int64

Yes

Page size.

Success Response

Response when no data is available


See also: Environment Setup

Last updated