Build and preview a roster
build_universeCreate a custom company roster for testing trading strategies. Specify size, seed, sectors, or explicit instruments to produce a universe document for run tools.
Instructions
Build a roster of companies and preview it, either generated from a size and seed (optionally concentrated on chosen sectors) or from explicit instruments you supply. Use it when the default random roster will not do, for example to test one sector or your own companies. Returns a universe document that every run tool takes as universe, with the roster's fingerprint and any envelope warning. Runs no market.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | Seed that generates the roster, 0 to 2**64 - 1. | |
| size | No | Names in a generated roster, 2 to 120. | |
| limit | No | How many instruments the preview lists. | |
| sectors | No | Lowercase sector ids to concentrate a generated roster on, for example ["technology", "energy"]. The ids: technology, financial_services, healthcare, energy, consumer_discretionary, consumer_staples, industrials, materials, real_estate, utilities, telecommunications, transportation. A concentrated roster is a named envelope gap, and the result says so. | |
| instruments | No | Explicit rows, 2 to 120, in roster order. Each needs ticker, sector (a lowercase id), initial_price and shares_outstanding. Give eps (earnings per share, valued at a sector P/E) or, for a loss-making company, book_value_per_share: a row with neither is refused, because the model would value it at one cent. Optional: revenue_growth, avg_volume, beta, short_interest (a share count, not a fraction). When given, size, seed and sectors are ignored. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||