Skip to main content
POST
/
api
/
v1
/
bundles
/
ticker_data
/
runs
finterm bundle run ticker_data AAPL
{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "run_id": "<string>",
    "bundle_name": "<string>",
    "descriptor_id": "<string>",
    "normalized_request": {},
    "submitted_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>",
    "updated_at": "<string>",
    "result": {},
    "error": {},
    "runtime_acknowledged": true,
    "manifest_ready": true,
    "links": {}
  }
}

Authorizations

Authorization
string
header
required

A live account API key from FINTERM_API_KEY.

Body

application/json
ticker
string

Stock ticker symbol

Minimum string length: 1
company_name
string

Company name

Minimum string length: 1
mode
enum<string>

Requested execution mode

Available options:
placeholder,
live
delivery_mode
enum<string>

Requested result delivery mode

Available options:
inline_result,
artifact_metadata,
summary_json,
dataroom_sync
parameters
object

Additional bundle parameters

Response

Run accepted.

The two-key success envelope.

finterm
object
required

Canonical result meta header.

data
object
required

The asynchronous bundle run state returned when a bundle run is accepted.