screen_universe
Screen the whole market on ONE completed day with several conditions ANDed together. Conditions use op >, <, >=, <=, between, top_pct or bottom_pct; top_pct/bottom_pct are deciles of the markets you can see. Answers 'top-decile funding with bottom-decile open-interest change' and 'open interest rising faster than volume'. A market that does not report a field never satisfies a condition on it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| day | No | The day to screen, `YYYY-MM-DD` or `latest`. | |
| coins | No | Restrict to these markets. | |
| scope | No | `crypto` (the default), `hip3`, or `all`. | |
| columns | No | Fields to return per market, from `list_fields`. | |
| order_by | No | The field to rank the matches by. Defaults to the day's traded notional. | |
| conditions | Yes | Conditions, all of which must hold. A market that does not report a field never satisfies a condition on it. | |
| descending | No | Rank largest first (the default). | |
| max_results | No | How many markets to return, 1..50. Defaults to 25. | |
| min_usd_volume_7d_avg | No | Drop markets below this average daily traded notional over the window. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | ||
| as_of | Yes | ||
| notes | Yes | ||
| scope | Yes | ||
| source | Yes | ||
| row_count | Yes | ||
| truncated | Yes | ||
| coin_count | Yes | The number of markets in your visible slice on that day — the denominator the percentage conditions and the floor were measured against. | |
| matched_count | Yes | How many markets met every condition. |