get_orderbook
Network orderbook. Full orderbook with rate levels, exact per-deposit availability, intent bounds and payment pairs, 24h activity, global stats, FX mid-rates, and DRM-aware metadata.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| taker | No | Optional taker wallet address. Without include_gated, returns only restricted deposit/payment-method tuples that wallet can access. Default results without a taker include public liquidity only. | |
| currency | No | Filter by fiat currency code (e.g. USD, GBP, EUR). Without filter, returns top 6 currencies by liquidity. | |
| min_size | No | Minimum USD liquidity per orderbook level (default: 50). | |
| platform | No | Filter by payment platform. | |
| include_gated | No | Set to 1 to include restricted deposits in the book. Payment pairs report whether every taker can use the tuple; protected tuples may still require stake. Combined with taker, the payload adds method-scoped taker_access instead of scoping the book. Default (omitted) keeps the public-only book unchanged. |