Skip to main content
POST
Stock research
Choose an action and its period or mode. Each request creates one Run; missing values remain null. Financial ratios are fractions, while macro rates are percentages. Read result_status and charge_usd separately. Use describe_filters: true with action: screen to discover supported filters before screening. Provider-native output remains on the Run.

Headers

idempotency-key
string
required

Generate a new unique value (prefer a random UUID) for each independent lookup, even with identical parameters on the same day. Retry the same intended execution with its original key and parameters to retrieve the original Run without another Charge. Changing execution parameters with the same key returns 409; changing task_id or metadata does not start a new Run. Existing opaque keys remain valid for recovery.

Minimum string length: 1

Body

application/json

One FinancialDatasets operation per request. Unused fields are rejected before charging. Empty data can still be charged. No currency conversion, estimated missing values or automatic pagination.

action
enum<string>
required
Available options:
company,
income,
balance_sheet,
cash_flow,
segments,
metrics,
earnings,
guidance,
prices,
news,
screen,
macro
provider
enum<string> | null

Default auto: select the first eligible Provider in Glasser's preference order. A named Provider must support the request and be allowed by your Key; it does not fall back to another Provider. Available values are listed below.

Available options:
auto,
financialdatasets
ticker
string | null
Minimum string length: 1
Pattern: ^[A-Za-z0-9.-]{1,12}$
cik
string | null
Minimum string length: 1
Pattern: ^\d{1,10}$
period
enum<string> | null
Available options:
annual,
quarterly,
ttm
mode
enum<string> | null

metrics/prices/macro only; defaults to snapshot. History requires the action-specific period or date inputs.

Available options:
snapshot,
history
statement
enum<string> | null
Available options:
all,
income,
balance_sheet,
cash_flow
macro
enum<string> | null
Available options:
interest_rates,
inflation,
yield_curve,
banks,
inflation_series
bank
string | null
Required string length: 1 - 200
series
string | null
Required string length: 1 - 200
limit
integer | null
Required range: 1 <= x <= 100
cursor
string | null
Required string length: 1 - 2000
interval
enum<string> | null
Available options:
day,
week,
month,
year
start_date
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
metric_name
string | null
Required string length: 1 - 200
filters
object[] | null
Required array length: 1 - 20 elements
describe_filters
boolean | null

screen only: true reads available fields, aliases, operators and company labels for free; filters and limit are then rejected.

report_period
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
report_period_gte
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
report_period_lte
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
report_period_gt
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
report_period_lt
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
filing_date
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
filing_date_gte
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
filing_date_lte
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
filing_date_gt
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
filing_date_lt
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
max_charge_usd
string | null

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
task_id
string | null

Group related Runs, including automatic fallback, under one Task. Reuse a stable string and filter the Runs list by task to retrieve them.

metadata

Optional tracking fields, returned on the Run and available as filters. They never go to the Provider or affect routing, Price, or idempotency.

  • Up to 20 keys: lowercase letters, digits, and underscores; start with a letter; at most 40 characters.
  • Values: strings of 1–500 characters.
  • user_id: your End user's opaque ID, never their email address or name.

Invalid entries are dropped whole, not truncated. The request continues, and the Run returns the fields that were stored.

Response

Success

Financial amounts retain currency; ratios and growth are unchanged fractions (0.3 means 30%). Macro rates and price day_change_percent are percentages. Missing fields are null. Run completed_at is retrieval time, never a substitute for an observation date.

id
string
required
run_url
string
required

Open this Run in the console. Requires Workspace membership.

provider
string
required
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
required
Pattern: ^\/.+$
endpoint_version
integer
required
status
enum<string>
required

QUEUED or RUNNING: still in progress. COMPLETED: a Provider response is available, including non-2xx responses. FAILED: read failure. STOPPED: stopped before dispatch. Read charge_usd separately from status.

Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
required

Why the Run failed. Non-null only when status is FAILED.

input
object
required
output
object
required
provider_response
object | null
required

Non-null only when status is COMPLETED.

  • For 2xx responses, output contains Provider-native JSON (any shape), or null for an empty body.
  • For non-2xx responses, error contains the Provider's error body and output is null.

Sensitive fields are removed from both bodies.

charge_usd
string | null
required

Historical total Charge of the listed Runs, including replayed or read Runs. Null until all listed Runs settle. This is not new spending by the current request; request_charge reports that separately. Failures can also be charged.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
required

Single-Run charge basis, or null for a multi-Run total. Read runs[].charge_basis for each charge.

stoppable
boolean
required

Whether a stop request can currently be accepted. This does not guarantee that the Run can stop before dispatch.

stop_requested_at
string<date-time> | null
required

When a stop was requested. The Run can still continue if dispatch had already started.

created_at
string<date-time>
required

ISO-8601 UTC timestamp

started_at
string<date-time> | null
required

ISO-8601 UTC timestamp

completed_at
string<date-time> | null
required

ISO-8601 UTC timestamp

task_id
string | null
required
metadata
object
required

Your stored tracking fields. Use them to filter Runs. They never go to the Provider or affect routing, Price, or idempotency.

  • Up to 20 keys: lowercase letters, digits, and underscores; start with a letter; at most 40 characters.
  • Values: strings of 1–500 characters.
  • user_id: your End user's opaque ID, never their email address or name.
action
enum<string>
required
Available options:
company,
income,
balance_sheet,
cash_flow,
segments,
metrics,
earnings,
guidance,
prices,
news,
screen,
macro
result_status
enum<string>
required
Available options:
success,
no_result,
error,
pending
error
object | null
required
runs
object[]
required
result_url
string
required

Authenticated, read-only URL path for polling this normalized result and total charge. Use with the API origin. Does not create Runs or resume fallback. GET /v1/runs/:id still returns the native, individual Run.

response_file
object

Complete large Provider body, delivered as a JSON file. Glasser applies a 32 MiB runtime resource guard to captured bodies and serialized files. body_field identifies the replaced field; output is null or provider_response.error is omitted. Download URLs expire after at most one hour. Authenticated Get Run refreshes the URL while the file is available, for 7 days. Reads and downloads do not execute or charge another Run. If state is link_pending, read the same Run to prepare the link without another execution or charge. The URL grants temporary read access: share it only with intended recipients.

review_invitation
object

Present at most once per Run, on the first delivery of some completed Runs. After you use this result for the task, submit a review as the instruction says, then continue. Optional; it never affects the Run or its charge.

request_charge
object

Request-scoped admission and Charge evidence. Record created_run_ids across the user's work, then count each settled Run once. Changing task_id does not turn an idempotent replay into a new Run. A result read has zero Charge and empty admission lists.