Use API Reference and the Request Simulator

Use the current endpoint catalog

Developers → API Reference is generated from the public endpoint catalog used by the server. Browse or search a family, then select the operation whose summary matches the question you need to answer. Read the path and method rather than choosing solely by a familiar word in the title. The public specification at /v1/openapi.json describes the current contract and can be fetched without a key. Documentation examples illustrate response shape; they do not prove that your API plan includes the dataset or that the selected environment has live upstream coverage.

Read requirements before filling the form

Inspect required parameters, allowed enum values, defaults, precision, result fields and pagination notes. An aggregate options endpoint can use an underlying family, while a contract endpoint needs the exact option root, expiration, strike and right. Futures can distinguish a product root from a dated contract. This is why copying one endpoint's query into another can fail even when both mention the same market. Prefer the reference's current parameter definitions to names guessed from a terminal widget, where controls can use a different presentation label.

Enter valid values in the simulator

Choose the intended project key or supply the key through the simulator's supported field. Enter only the documented parameters. Dates use YYYY-MM-DD, public API timestamps use UTC Unix milliseconds and start bounds are inclusive while end bounds are exclusive. Enum values use their documented spelling. Unknown, repeated, missing and malformed parameters are refused explicitly. A comma-separated list is different from repeating one parameter several times. Quote strikes also retain their documented precision, so avoid rounding an exact contract into a different requested instrument.

1. Select an endpoint and inspect its required parameters and schema.
2. Choose the intended key and enter a narrow valid selection.
3. Review the built request, then use Send and inspect the actual response.

Inspect status, timing and request metadata

After sending, the response panel reports HTTP status, duration, body size, request ID and rate or retry information when available. Read the structured error code and parameter details rather than only the colored status. A browser-level failure without a JSON response is different from an API response containing an endpoint error. The simulator is a real request workflow, not a synthetic data generator, so it uses the account's API permission and request allowance. Stop or leave an in-flight request through the available controls when you no longer need it.

Use Tree, Raw, Copy and Download

Tree helps explore a structured JSON body, while Raw shows the response text. Large responses can show a bounded text preview instead of drawing a huge expandable tree. The panel explains when only the start is displayed and offers the whole text or a download when available. Download keeps the response body; the visible preview alone may not include every row. Copy is useful for a safe minimized example, but inspect it before sharing so no unrelated personal data or request credential is included.

Continue a paginated result correctly

Use Next page when the response provides a valid continuation, keeping the original route and selection unchanged. A short filtered page can still require continuation because the server bounded scan work before finding all matches. Read data, pagination and coverage together. Changing symbols, filters, time bounds or other selection parameters starts a new query rather than continuing the old cursor. If a ranking reports snapshot_changed, recognize that rows may move between pages and a fresh scan may be needed for a consistent interpretation.

Turn a simulator result into a reproducible report

When moving to your own client, compare the built request and selected language example with the successful simulator request, keeping the key private. For failure, include the route, safe parameter values, structured error code, request ID and relevant coverage. A 400 normally needs input correction; 401 concerns authentication; 403 can concern subscription, dataset or history. Honor retry instructions on 429 or 503. All account keys share 250 requests per rolling minute and a 30-per-second burst limit, with no credits, so running several simulator tabs is not additional capacity.