How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FERC eForms XBRL Submission API

The machine-to-machine API behind FERC's mandated eForms. Credentialed filers exchange their FERC eRegistration and Company Registration username and password for a bearer token at POST /api/token (OAuth2 password grant, role=filer), then POST a zipped XBRL submission to /api/SubmissionHistory/ExternalFiling with the company CID, report year, report period, and form identifier. FERC documents only that write path, but the API is not write-only — a second-round probe on 2026-07-27 found an undocumented ANONYMOUS read surface on the same host — GET /api/PublicSubmissionHistory (37,588 filing records, 10.6 MB, no key), /api/SubmissionDetail/{filingID} (accession number and attachment manifest), /api/SubmissionHistory/forms, /api/getTestStatus, /api/faq, and the full XBRL taxonomy release history at /api/TaxonomyHistory with its taxonomy packages, sample forms and release notes. Those endpoints are described in a DERIVED OpenAPI in this repo (FERC publishes none), built from FERC's own production JavaScript bundle plus its published Postman collection, with every path probed live. Verified 2026-07-27 — POST /api/token without valid credentials returns HTTP 400 with "Failed validating user in company registration", and the credentialed endpoints (/api/claims, /api/SubmissionHistory, /api/TaxonomyRevision) return HTTP 401.

FERC eForms XBRL Submission API is one of 2 APIs that FERC publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include XBRL, Regulatory Filing, eForms, and Compliance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 14 operations across 14 paths, organized into 4 resource areas, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2026-07-27.

Requests are made against a single base URL, https://ecollection.ferc.gov/api.

14 operations 14 paths 6 schemas 12 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-07-27
Base URL
https://ecollection.ferc.gov/api
Authentication
HTTP Bearer
Resource Areas
4

Authentication & Security 1

FERC eForms XBRL Submission API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (filerBearer).

  • filerBearer — Bearer token issued by POST /token via the OAuth 2.0 password grant with role=filer.

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 12 GET, 2 POST. They span 4 resource areas: Filing, Public Filings, Reference, Taxonomy. Each is listed below with its method, path, parameters, and response codes.

Filing 4

Credentialed machine-to-machine submission of XBRL filings.

POST
/token
Exchange FERC eRegistration credentials for a bearer token
getFilerToken body → 200400
POST
/SubmissionHistory/ExternalFiling
Submit a zipped XBRL filing
postExternalFiling body → 200401
GET
/claims
Get the authenticated filer's claims
getFilerClaims → 200401
GET
/SubmissionHistory
List the authenticated filer's submission history
listFilerSubmissionHistory → 200401
Public Filings 2

Anonymous read access to the public FERC eForms submission record.

GET
/PublicSubmissionHistory
List the public FERC eForms submission history
listPublicSubmissionHistory 1 param → 200
GET
/SubmissionDetail/{filingID}
Get the detail and attachment manifest for one filing
getSubmissionDetail 1 param → 200
Reference 3

Form lists and submission constraints.

GET
/SubmissionHistory/forms
List the eForms form names and identifiers
listForms → 200
GET
/getTestStatus
Get submission constraints and test-mode status
getTestStatus → 200
GET
/faq
List eForms portal FAQ entries
listFaq → 200
Taxonomy 5

XBRL taxonomy versions, packages and sample forms for the FERC eForms.

GET
/TaxonomyHistory
List published XBRL taxonomy versions
listTaxonomyHistory → 200
GET
/TaxonomyHistory/TaxonomyFile/{versionID}
Download the taxonomy file bundle for a version
getTaxonomyFile 1 param → 200
GET
/TaxonomyHistory/SampleForm/{versionID}
Download the sample/blank rendered form bundle for a taxonomy version
getTaxonomySampleForm 1 param → 200
GET
/TaxonomyHistory/getReleaseFiles
Get the taxonomy release notes document
getTaxonomyReleaseFiles → 200
GET
/TaxonomyRevision
List taxonomy revisions (administrative)
listTaxonomyRevisions → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TaxonomyVersion (11 properties), PublicSubmission (11 properties), SubmissionDetail (7 properties), TestStatus (6 properties). Each schema is shown below with its type and property counts.

PublicSubmission
object
One public eForms filing record. Field set observed verbatim on 2026-07-27; no field added.
11 properties
SubmissionDetail
object
7 properties
FormList
object
3 properties
TestStatus
object
6 properties
TaxonomyVersion
object
11 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ferc-eforms-api-openapi-derived.yml Raw ↑

Other APIs FERC publishes across the network.

FERC Open Data API
Where this information came from

This is an independent, third-party profile of FERC eForms XBRL Submission API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.