Skip to main content
GET
/
api
/
v1
/
account_volume
Get aggregate account volume over a date range
curl --request GET \
  --url https://api.mainnet.aptoslabs.com/decibel/api/v1/account_volume \
  --header 'Authorization: Bearer <token>'
{
  "account": "<string>",
  "end_date": "<string>",
  "maker_volume": "<string>",
  "start_date": "<string>",
  "taker_volume": "<string>",
  "volume": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Query Parameters

​
account
string
required

User account address

​
start_date
string

Optional inclusive start date (YYYY-MM-DD, UTC). Must be provided together with end_date. Defaults to today() - 29 (UTC) when both are omitted.

​
end_date
string

Optional inclusive end date (YYYY-MM-DD, UTC). Must be provided together with start_date. Defaults to today (UTC) when both are omitted.

Response

Account volume retrieved

Response for GET /api/v1/account_volume?account=<address>&start_date=<YYYY-MM-DD>&end_date=<YYYY-MM-DD>.

Returns the account's aggregate trading volume (total, maker, taker) in whole USD for the requested inclusive date range. When start_date/end_date are omitted the range defaults to the past 30 days (today() - 29 .. today() inclusive, UTC).

Volume data has up to 5-minute delay (MV refresh interval).

​
account
string
required

The queried account address

​
end_date
string
required

Inclusive end date of the range used (YYYY-MM-DD, UTC)

​
maker_volume
string
required

Maker-side volume across the range (USD, whole-dollar integer string)

​
start_date
string
required

Inclusive start date of the range used (YYYY-MM-DD, UTC)

​
taker_volume
string
required

Taker-side volume across the range (USD, whole-dollar integer string)

​
volume
string
required

Total volume across the range (USD, whole-dollar integer string)