FinancialReports

List all filing types

Developing

GET/filing-types/

Overview

This endpoint retrieves a list of all available filing types in the system. Filing types categorize the various kinds of financial documents and regulatory filings that companies submit.

Key features:

Provides a comprehensive list of filing type codes and names
Includes descriptions for each filing type
Supports search functionality for easy lookup

Search Functionality

The endpoint allows searching across:

Filing type code
Filing type name

This feature enables quick location of specific filing types or groups of related types.

Usage

This endpoint is particularly useful for:

Understanding the range of document types available in the system
Filtering company filings by specific document types
Building user interfaces with dropdown menus or autocomplete features for filing type selection
Standardizing filing type references in data analysis and reporting

Researchers, developers, and analysts can use this endpoint to ensure they're using the correct filing type codes when querying the main filings endpoint or to gain an overview of the types of documents available in the system.

Request

Query Params

page

integer

optional

The current page number to navigate through the paginated results

Example:

page_size

integer

optional

The number of items to return per page

Example:

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

$ref(#/definitions/3435969)[]

optional

#/definitions/3435969

optional

[
  {
    "code": "VOS",
    "name": "uxor",
    "description": "suggero desparatus balbus"
  },
  {
    "code": "EX",
    "name": "tamdiu",
    "description": "administratio admiratio alii"
  }
]

Last modified: 2 months ago