Developers menu

Developers / LAB / Poll an options run

Markdown copy

Poll an options run

A structure run's state: running, done with its result, or error with the credits refunded.

GET/api/struct/job
Plan LABKey scope labLimit Credits; one idea on the conveyor at a timeVersion 1.0.0Since 2026-08-31

This endpoint serves

Plan: LAB. LAB credits: developing an idea is free, a backtest or an optimize pass is one credit, the desk is free once an idea is tested. LIVE includes 5 credits a month. Pricing.

Parameters

NameWhat it doesDefaultError
idrequiredquery · stringThe job named by /api/struct/run

Response

{ state, result? , error?, refunded? }.

FieldMeaningUnit
statestringrunning, done or error.

Errors

StatusCodeWhat to do
404No such idea or job. Check the id.

Every code: Errors.

Changes

  • 2026-08-31 Added.

OpenAPI operation structJob in /docs/developers/openapi.json.

Measurements of dealer positioning, never a forecast or a trade call. This page is built from FirmTape's public contract, the same files the OpenAPI document is built from; the tests hold them against the route code. Markdown: /docs/developers/lab/options-job.md.