REST API

EDGAR Report Information Web Service -- Developer Documentation

Getting Started

Here are a few things you will want to know to get you started using the XBRL Cloud EDGAR Information Web Service.

  • You will need to register with XBRL Cloud to access the web services programatically: you cannot use your social media login unless you are in the browser
  • You can access any URL in the browser, click this now!
    https://eri.xbrlcloud.com/edgar-report-information/rest/entities
  • You can access any curl at the command line to try things out:
    curl -k -v -u'{user:password}' -X GET https://eri.xbrlcloud.com/edgar-report-information/rest/entities
  • All services return XML or XHTML. The default is dependent upon the HTTP headers of the caller. Generally, a browser will default to XHTML, and all others will default to XML

Entry Points

This section describes the primary entry points to the EDGAR Report Information Web Service. Note that most other URLs are discoverable in the browser.

The list of SEC Registrants (a.k.a. Entities): https://eri.xbrlcloud.com/edgar-report-information/rest/entities
The list of SIC Codes, and the related entity counts: https://eri.xbrlcloud.com/edgar-report-information/rest/sic-codes
The list of Document Types, and the related entity counts: https://eri.xbrlcloud.com/edgar-report-information/rest/document-types
The list of Disclosure Objects, and the related entity counts: https://eri.xbrlcloud.com/edgar-report-information/rest/disclosure-objects

Most Resources (Web Service URLs) can search, or filter, the results using the search option.

Here is an example of the list of SEC Registrants that are trusts, and are not going concerns:
https://eri.xbrlcloud.com/edgar-report-information/rest/entities?search=IsTrust:true;GoingConcern:false

  • Note that the general form of the search parameters are option1:value1a,value1b,value1c;option2:value2a,value2b,value2c
  • Use the delimiter : to separate the option and the value, such as IsTrust:true
  • Use the delimiter ; to separate multiple options, such as IsTrust and GoingConcern

Please note: The following discussion talks about filtering entities, but most or all options can be used to filter filings, disclosure objects--virtually any URL.

The available search options are:

IsTrust:{true,false}
Show only entities that are or are not trusts.
IsFund:{true,false}
Show only entities that are or are not funds.
IsGoingConcern:{true,false}
Show only entities that are or are not going concerns.
IsDevelopingStage:{true,false}
Show only entities that are or are not in a developing stage.
IsCurrentlyReporting:{true,false}
Show only entities that are or are not currently reporting with the SEC.
IsVoluntaryFiler:{true,false}
Show only entities that are or are not voluntary filers at the SEC.
IsWellKnownSeasonedIssuer:{true,false}
Show only entities that are or are not well known seasoned issuers at the SEC.
EntityType:{Corporation, Partnership, Association, Cooperative, Unknown}
Show only entities of a particular type. Accepts multiple values.
FilerCategory:{Large Accelerated Filer, Smaller Reporting Company, Accelerated Filer, Smaller Reporting Accelerated Filer, Non-accelerated Filer}
Show only entities of a particular size. Accepts multiple values.
FiscalYearFocus:{2013, 2012, 2011, 2010, 2009, 2008}
Show only entities that have filed in a particular year. Accepts multiple values. The values might, of course change.
DocumentType:{10-K, 10-Q, etc.}
Show only entities that have submitted a particular document type. Accepts multiple values.
StandardIndustrialClassification:{100, 200, 2020, etc.}
Show only entities in a particular set of SIC codes. Accepts multiple values.