Skip to main content

Firm Datasets

The datasets shown in the table below are available as part of the Firm API.

The API platform utilizes the concept of datasets to deliver a variety of data via the GET Data and POST Data endpoints. All datasets are associated with a dataset group and have a dataset name. Therefore the GET Data and POST data endpoints utilize the following structure:

/data/group/{group name}/name/{dataset name}

Utilize the /metadata/group/{group name}/name/{dataset name} endpoint to retrieve details of the fields for each dataset.

 

IMPORTANT:

  1. Only the test datasets are available using your API Developer Center credentials obtained via the REQUEST TEST ACCESS menu option. The production datasets will only be available once you have gone through the production provisioning process, for those datasets requiring production provisioning (as shown in the table below).
  2. The test datasets contain mock or fictional data that is representative of the type of data that will be found in production.

 

API dataset group name dataset name test dataset name status production provisioning required
Firm firm        
NEW   4530filings 4530filingsMock available yes