New Deepbook Indexer Endpoints

MystenLabs / sui

Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language

Apache License 2.0

6.27k stars 11.21k forks source link

Description

Allow for querying for quote asset
Removed 24 hour endpoints, historical endpoints will return 24 hour volume using base asset by default if query params not given
Interval default is 1 hour for interval endpoint

Endpoint call examples: Public endpoint: https://deepbook-indexer.mainnet.mystenlabs.com/

/get_historical_volume/:pool_ids?start_time=1731260703&end_time=1731692703&volume_in_base=true
/get_historical_volume_by_balance_manager_id/:pool_ids/:balance_manager_id?start_time=1731260703&end_time=1731692703&volume_in_base=true
/get_historical_volume_by_balance_manager_id_with_interval/:pool_ids/:balance_manager_id?start_time=1731260703&end_time=1731462703&interval=86400&volume_in_base=true

Default without param is volume in the last 24 hours, using volume in base asset (SUI in SUI/USDC pool as example)

Test plan

How did you test the new or updated feature?

Tested locally, updated docs

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.