Skip to main content

Datasets

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}

NOTE: Only the test dataset is available using your API Developer Center credentials obtained via the REQUEST API KEY menu option. The production dataset will only be available once you have gone through the production provisioning process.

API dataset group name dataset name test dataset name status
Market Transparency        
  OTCMarket equityShortInterest equityShortInterestMock available
  OTCMarket thresholdList thresholdListMock available
  OTCMarket weeklySummary weeklySummaryMock available
  OTCMarket monthlySummary monthlySummaryMock available
  OTCMarket blocksSummary blocksSummaryMock available
  OTCMarket otcBlocksSummary otcBlocksSummaryMock available
Registration        
  Firm registeredIndividual registeredIndividualMock available
  Firm registeredIndividualBranchOfficeLocations registeredIndividualBranchOfficeMock available
  Firm registeredIndividualCompletedExams registeredIndividualCompletedExamsMock available
  Firm registeredIndividualDeficiencies registeredIndividualDeficienciesMock available
  Firm registeredIndividualDisclosures registeredIndividualDisclosuresMock available
  Firm registeredIndividualEmployments registeredIndividualEmploymentsMock available
  Firm registeredIndividualProfessionalDesignations registeredIndividualProfessionalDesignationsMock available
  Firm registeredIndividualRegistrations registeredIndividualRegistrationsMock available
  Firm registeredIndividualResidentialLocations registeredIndividualResidentialLocationsMock available
         
  Firm branchOffice branchOfficeMock available
  Firm branchOfficeDetails branchOfficeDetailsMock available
  Firm branchOfficeLocations branchOfficeLocationsMock available
  Firm branchOfficeFinancialActivities branchOfficeFinancialActivitesMock available
  Firm branchOfficeAssociatedIndividuals branchOfficeAssociatedIndividualsMock available