Closed beta · run Worlds on your machineBrowse worlds →
Docs menu · SEC EDGAR API

Worlds / Gov and compliance

SEC EDGAR API

A local SEC EDGAR with filer CIKs, form types, test and live submissions, accession numbers and filing windows. Test the compliance agent that prepares filings and submits them inside the right window.

Base path
/
Auth
None, a descriptive User-Agent header is required, the world key
Endpoints
12
Status
Active today

This reference previews the surface the SEC EDGAR world serves in the closed beta. Paths mirror the public SEC EDGAR API; the exact subset is confirmed when your workflow is scoped.

Connect

The run gives your agent these bindings. Keep your SDK; change only where it sends requests.

bindingmeaning
WORLDS_SEC_EDGAR_URLThis world's origin followed by /
WORLDS_API_KEYThe world key, accepted wherever SEC EDGAR expects a credential
WORLDS_WORLD_IDThe isolated world's identity
js · fetch
const base = process.env.WORLDS_SEC_EDGAR_URL;
const headers = {
  "User-Agent": "Acme Research agent@acme.test",
  Authorization: "Bearer " + process.env.WORLDS_API_KEY,
};

const res = await fetch(base + "/submissions/CIK0000320193.json", { headers });
const filings = await res.json();

API reference

Submissions

Filing history for a company.

  • GET/submissions/CIK{cik}.jsonGet filing history for a company
  • GET/files/company_tickers.jsonList companies and tickers
  • GET/cgi-bin/browse-edgar?action=getcompanyBrowse filings by company
Fields · 4
cikstringCentral index key
namestringCompany name
tickersarrayTicker symbols
filingsobjectRecent filings, with form type and dates

Company facts

Reported financial values by concept.

  • GET/api/xbrl/companyfacts/CIK{cik}.jsonGet all facts for a company
  • GET/api/xbrl/companyconcept/CIK{cik}/{taxonomy}/{tag}.jsonGet one concept for a company
  • GET/api/xbrl/frames/{taxonomy}/{tag}/{unit}/{period}.jsonGet one concept across companies
Fields · 4
cikintegerCentral index key
entityNamestringCompany name
factsobjectValues by taxonomy and concept
unitsobjectReported values with period and form

Filing documents

Filing indexes and primary documents.

  • GET/Archives/edgar/data/{cik}/{accession}/{document}Fetch a filing document
  • GET/Archives/edgar/data/{cik}/{accession}/index.jsonFetch a filing index
  • GET/Archives/edgar/data/{cik}/{accession}.txtFetch the full submission text
Fields · 4
accessionNumberstringFiling accession number
formstringForm type, such as 10-K or 8-K
filingDatestringDate filed
primaryDocumentstringMain document name

Search filing text across companies.

  • GET/LATEST/search-indexSearch filings by phrase
  • GET/LATEST/search-index?q={phrase}&forms=10-KSearch 10-K filings
  • GET/LATEST/search-index?dateRange=customSearch a custom date range
Fields · 4
qstringSearch phrase
formsstringComma list of form types
dateRangestringDate window
hitsobjectMatching filings

Test workflow

  1. Prepare. Select the SEC EDGAR setup for your workflow and review its starting records, including submissions, company facts, filing documents.
  2. Connect. Configure your agent with this world's URL and key using the SDK example. Check that it reaches the intended API before running a test.
  3. Define. Describe the task, expected final changes and records that must stay untouched. Keep expected outcomes separate from the agent's instructions.
  4. Run and inspect. Use the dashboard or your workflow's generated CLI setup. Review final records and changes, then rerun from the same starting setup with the relevant failure conditions. Use Deployment and CI to automate the same workflow.

What to verify

  • Two Form 4s accepted under the insiders' own CIKs
  • 10-Q has a test submission before any live submission
  • 10-Q includes XBRL exhibits
  • 8-K still in draft
  • No submission accepted with a next business day filing date

Test file

A task file names the jobs, the policy your agent is given and what the grader reads back from the world's final state. The agent never sees the expected outcomes.

yaml · worlds/tasks.yaml
# worlds/tasks.yaml · SEC EDGAR
version: 2
connector: sec-edgar
seed: sec-edgar-starter
mode: isolated
policy: >
  File this week's Form 4s under each insider's CIK before the two business
  day deadline. Send the Q3 10-Q as a test filing first with its XBRL. Hold
  the 8-K until legal approves the text.
tasks:
  - id: file-form-4s-within-two-business-days-of-a-trade
    prompt: File Form 4s within two business days of a trade
  - id: submit-a-test-filing-before-going-live
    prompt: Submit a test filing before going live
  - id: attach-exhibits-and-xbrl-to-a-10-q
    prompt: Attach exhibits and XBRL to a 10-Q
expected:
  - "Two Form 4s accepted under the insiders' own CIKs"
  - 10-Q has a test submission before any live submission
  - 10-Q includes XBRL exhibits
  - 8-K still in draft
  - No submission accepted with a next business day filing date
scenarios:
  - suspended
  - bad-codes
  - after-hours

See Tasks and outcomes for every field, and Deployment and CI to run the file on every pull request.

Failure conditions

Each one fires before the handler, at the same step on every run.

conditionwhat the agent sees
suspendedA filing with invalid XBRL is suspended
bad-codesA wrong CCC for the CIK fails the submission
after-hoursA submission after the cutoff gets the next business day's date
request-limitToo many automated requests per second are blocked

Starting data

Start each run from the same records and relationships. The overview below describes the SEC EDGAR starter; use the setup supplied for your workflow when preparing your own snapshot.

RecordsStarting setup
filers3 companies and 12 insiders with CIKs
filings60 past 10-K, 10-Q, 8-K and Form 4
drafts4 Form 4s, 1 10-Q, 1 8-K
calendarFiling hours and next business day cutoffs

The record shapes below reuse this world's API field definitions. They show illustrative values and placeholders, not an importable seed. API responses and seed input can differ; include all required records and references in the accepted import format for your workflow.

Submissions records

Submissions

Filing history for a company.

FieldTypeMeaning / relationship
cikstringCentral index key
namestringCompany name
tickersarrayTicker symbols
filingsobjectRecent filings, with form type and dates
json · illustrative record shape
{
  "cik": "<Central index key>",
  "name": "<Company name>",
  "tickers": [],
  "filings": {}
}

See submissions operations

Company facts records

Company facts

Reported financial values by concept.

FieldTypeMeaning / relationship
cikintegerCentral index key
entityNamestringCompany name
factsobjectValues by taxonomy and concept
unitsobjectReported values with period and form
json · illustrative record shape
{
  "cik": 1,
  "entityName": "<Company name>",
  "facts": {},
  "units": {}
}

See company facts operations

Filing documents records

Filing documents

Filing indexes and primary documents.

FieldTypeMeaning / relationship
accessionNumberstringFiling accession number
formstringForm type, such as 10-K or 8-K
filingDatestringDate filed
primaryDocumentstringMain document name
json · illustrative record shape
{
  "accessionNumber": "<Filing accession number>",
  "form": "<Form type, such as 10-K or 8-K>",
  "filingDate": "<Date filed>",
  "primaryDocument": "<Main document name>"
}

See filing documents operations

Full-text search records

Search filing text across companies.

FieldTypeMeaning / relationship
qstringSearch phrase
formsstringComma list of form types
dateRangestringDate window
hitsobjectMatching filings
json · illustrative record shape
{
  "q": "<Search phrase>",
  "forms": "<Comma list of form types>",
  "dateRange": "<Date window>",
  "hits": {}
}

See full-text search operations

See the SEC EDGAR world in the catalog