Skip to main content
POST
SEC filings research
Choose one of 11 actions: resolve, search, section, document, events, compensation, board, audit_fees, ipo, private_placements or enforcement. Requests use the same Run admission, idempotency, Key Policy and charging rules as other Solutions. Native Provider data remains on the Run. Section reads preserve the same accession and Part/Item when using a FinancialDatasets alternative. A prior filing-index source_run_id verifies filing provenance. Pay years, filing dates, accepted timestamps and effective dates remain distinct. Reported currency and missing values are preserved; targets, sold amounts, share counts and net proceeds must not be substituted. Private placements require offering_type: form_d, form_c or reg_a. Reg A supports all, 1-A, 1-K and 1-Z. Enforcement requires record_type: actions, litigation, administrative or aaer. Each request reads one Endpoint and page; null totals or cursors do not prove completion. Check result_status and actual charges separately. Large normalized output is delivered completely through response_file. Read result_url to reuse the same data without another execution or Charge.

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
action
enum<string>
required
Available options:
resolve,
search,
section,
document,
events,
compensation,
board,
audit_fees,
ipo,
private_placements,
enforcement
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,
secapi,
financialdatasets
ticker
string | null
Required string length: 1 - 12
cik
string | null
Minimum string length: 1
Pattern: ^\d{1,10}$
cusip
string | null
Minimum string length: 1
Pattern: ^[A-Za-z0-9]{6,9}$
name
string | null
Required string length: 1 - 100
query
string | null

Provider-native Lucene clause. Structured filters are ANDed with this clause; raw syntax is not repaired. A malformed SEC API query can return an empty answer.

Required string length: 1 - 3500
form_types
string[] | null
Minimum array length: 1
Minimum string length: 1
accession_number
string | null
Minimum string length: 1
Pattern: ^\d{10}-\d{2}-\d{6}$
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}$
limit
integer | null
Required range: 1 <= x <= 100
offset
integer | null
Required range: 0 <= x <= 10000
cursor
string | null
Required string length: 1 - 2000
sort_order
enum<string> | null
Available options:
asc,
desc
filing_url
string | null
Minimum string length: 1
url
string | null
Minimum string length: 1
form_type
enum<string> | null
Available options:
10-K,
10-K/A,
10-Q,
10-Q/A,
8-K,
8-K/A
item
string | null

Section identity: 10-K uses 1A or 7; 10-Q uses part1item1 or part2item1a; 8-K uses 4.01, 4.02 or 5.02. Codes are checked against the requested form and Provider.

Required string length: 1 - 30
source_run_id
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
year
integer | null
Required range: 1993 <= x <= 2100
quarter
integer | null
Required range: 1 <= x <= 4
include_exhibits
boolean | null
event_types
enum<string>[] | null
Minimum array length: 1
Available options:
auditor_change,
non_reliance,
director_officer_change
year_from
integer | null
Required range: 1993 <= x <= 2100
year_to
integer | null
Required range: 1993 <= x <= 2100
executive_name
string | null
Required string length: 1 - 200
classification
enum<string> | null
Available options:
ipo,
shell_company,
spac,
resale,
other
offering_type
enum<string> | null
Available options:
form_d,
form_c,
reg_a
reg_a_form
enum<string> | null
Available options:
all,
1-A,
1-K,
1-Z
record_type
enum<string> | null
Available options:
actions,
litigation,
administrative,
aaer
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

Normalized SEC evidence with exact filing/section identity and source Runs. Missing fields remain null, offering targets are distinct from sold amounts and enforcement allegations are distinct from outcomes. Native Provider output remains on the Run. Result reads are free and do not resume execution.

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:
resolve,
search,
section,
document,
events,
compensation,
board,
audit_fees,
ipo,
private_placements,
enforcement
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 normalized SEC output as JSON, replacing output. Links refresh only within the Run's seven-day file retention period. Native Provider files remain on Get Run.

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.