HomeDocumentationAPI Reference
Log In
API Reference

Get Detailed Maker Snapshot History

Method Name

public/get_detailed_maker_snapshot_history

Get detailed maker snapshot history. Note that for OPTION asset types the snapshots are only available for
the last few days.

Parameters

epoch_start_timestamp  integer required
Start timestamp of the program epoch

program_name  string required
Program name

wallet  string required
Wallet address of the maker

page  integer
Page number of results to return (default 1, returns last if above num_pages)

page_size  integer
Number of results per page (default 100, max 1000)

Response

id  string or integer required

result  object required

result. pagination  object required
Pagination information

result.pagination. count  integer required
Total number of items, across all pages

result.pagination. num_pages  integer required
Number of pages

result. program  object required
Program details

result.program. end_timestamp  integer required
End timestamp of the epoch

result.program. min_notional  string required
Minimum dollar notional to quote for eligibility

result.program. name  string required
Name of the program

result.program. start_timestamp  integer required
Start timestamp of the epoch

result.program. asset_types  array of strings required
List of asset types covered by the program

result.program. currencies  array of strings required
List of currencies covered by the program

result.program. rewards  object required
Rewards for the program as a token -> total reward amount mapping

result. snapshots  array of objects required
Detailed maker snapshot history

result.snapshots[]. asset_type  string required
Asset type of the snapshot

result.snapshots[]. bbo_factor  string required
BBO factor of the maker

result.snapshots[]. best_price  string required
Best price of the snapshot

result.snapshots[]. coverage_score  string required
Coverage score of the maker

result.snapshots[]. currency  string required
Currency of the snapshot

result.snapshots[]. deducted_factor  string required
Deducted factor of the maker

result.snapshots[]. deducted_notional  string required
Deducted notional of the maker

result.snapshots[]. index_price  string required
Index price of the snapshot

result.snapshots[]. instrument_factor  string required
Factor for the instrument

result.snapshots[]. instrument_name  string required
Instrument name of the snapshot

result.snapshots[]. is_bid  boolean required
Whether the snapshot is a bid or ask

result.snapshots[]. mid_price  string required
Mid price of the snapshot

result.snapshots[]. notional  string required
Notional of the maker

result.snapshots[]. quality_score  string required
Quality score of the maker

result.snapshots[]. scaled_notional  string required
Scaled notional of the maker

result.snapshots[]. timestamp  integer required
Timestamp of the snapshot

result.snapshots[]. total_scaled_notional  string required
Total scaled notional of the snapshot

result.snapshots[]. wallet  string required
Wallet address of the maker

result.snapshots[]. quotes  array of arrays required
List of maker quotes in the snapshot

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}