openapi: 3.2.0
info:
description: "## Precision News API \n\n The Precision News APIs provide access to curated news annotated with metadata tags. There are three APIs that access their own data sets, municipal, economic, and corporate. Each API has a specific way of querying the data sets and specific data they return, which is described in each of the respective API descriptions, the [Municipal News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) and the [Economic News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) and the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). All of the API's are built on a common foundation described below. \n\n A news article is tagged with metadata that describes the content of the article. Each data set has its own set of unique tags but there is a common set depicted below \n\n  \n\n News queries are time based. The news can be queried either within a specified time window or by a number of days back in history from the current day. The dates used when specifying a time window can be based on the published date of an article or the date which the article was made available by the system. When using a polling strategy to query the latest news using the API, the available date is recommended as published dates can be less predictable. Due to the large number of news articles that may be returned because of a broad criteria or a large window a limit on the number of articles to return by the system can be specified. \n\n Responses to queries are capped at 1000 articles. It is possible however that there are more than 1000 articles that match a given query. To accommodate queries that match more than the maximum size the concept of paging is supported. A page is a set of articles returned by a single query. It may be less than the total result set. The client can indicate which page they want returned on each call. This allows the client to loop through the result set one page at a time until the entire result set is returned. \n\n Both the page to return and the size of the page are specified by the client with the pageNo and pageSize parameters respectively. Each API will list these parameter options as either query parameters or properties of the input message body. A query parameter example is as follows: \n\n ```js\n GET ...&pageNo=1&pageSize=100 HTTP 1.1\n ```\n \n\n This instructs the API to return the first page with a maximum of 100 articles in it. Each news response will identify the number of articles returned for the current page and the total number of articles in the result set so the client can loop if needed. For example: \n\n ```js\n {\n \t\"success\": true,\n \t\"returned\": 100,\n \t\"total\": 1000, \n \t... \n ``` \n The above response indicates the requested page of 100 articles are in the response but there were a total of 1000 articles that matched the query. To then ask for the second page of the result set the pageNo parameter would be incremented as follows: \n\n ```js\n GET ...&pageNo=2&pageSize=100 HTTP 1.1\n ```\n \n\n In this example the next response will return the 101st to 200th article in the result set. \n\n The corporate and municipal data sets require their own API key. The economic data set is shared between the corporate and municipal data sets and does not require its own key. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page. \n\n## Entity API \n\n The corporate entities, companies or organizations, that the articles the Corporate News API returns are persisted in the Bitvore Knowledge Graph. The Entity API provides access to the information about those corporate entities. \n\n  \n\n Companies can be searched for based on some criteria or directly using a Bitvore ID which uniquely identifies an entity in the Bitvore system. When using the Bitvore ID the entire company profile will be returned for that single company. If one is unsure what the Bitvore ID of a company is a search can be performed using different profile properties such as name, ticker, industry, etc. The API will return all companies that match the search criteria. Only summary information is returned but it should be enough information to identify the exact company being searched for. Once the Bitvore ID is found news can be retrieved for the company using the Corporate News API. \n\n  \n\n The Bitvore ID for a company never changes so it is recommended that clients save the Bitvore IDs for future use instead of calling the Entity API each time if possible. \n\n Each company has a monitoring state field which can have the value \"active\" or \"inactive\". Active companies are being monitored by Bitvore so news is being currently collected. An inactive company will need to be activated in order to start news collection. If you see an inactive company you would like activated please contact [customer support](mailto:support@bitvore.com). \n\n The Entity API is part of the corporate data set and requires a corporate data set API key for access. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n## Portfolio API \n\n Bitvore RESTful APIs useful for integrating with a business portfolio so that querying news articles can be focused on business relevant entities and performed in a simplified manner. Two separate APIs are provided to support two different integration approaches. \n\n * The Portfolio Management API provides the ability to create, or replicate, a business portfolio in the Bitvore system. \n * The Identification API maps custom identifiers to Bitvore IDs so that the business portfolio does not have to be replicated in the Bitvore system. \n \n\n Access to any of the Portfolio APIs requires an API key or an API user account for backwards compatibility with 1.0 customers. \n\n A Bitvore Corporate News API key can be used to access any of the Portfolio APIs. A Bitvore Municipal News API key can be used to access the Portfolio Management API only. To register for an API Key please contact [customer support](mailto:support@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page. \n\n ### Portfolio Management API \n\n The Portfolio Management API provides the ability to create, or replicate, a business portfolio in the Bitvore system. The entities to be tracked in the portfolio are identified by either CUSIPs (for bonds) or Bitvore IDs (for companies). The benefit of creating a portfolio in Bitvore is the news APIs both take a portfolio ID as a parameter making it easy to retrieve news for a portfolio. \n\n If creating a portfolio of companies in Bitvore the Bitvore ID of each company will be needed. This ID can be obtained from a company's profile using the Entity API. \n\n  \n\n The returned Bitvore ID can then be added to the portfolio. When querying for news about the portfolio the news for that company will be returned. \n\n A set of sample CSV files listing companies found [here](http://developer.bitvore.com/v1/docs/api-reference/portfolios) can be used to quickly create portfolios of your own. Simply download the CSV file you want to create your portfolio with, create a new company (BVID) portfolio, and then use the [Upload Portfolio Items](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) API call to fill the new portfolio from the CSV file. Note the portfolio ID generated and then use that ID when querying for portfolio news using the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). \n\n Each company has a monitoring state field which can have the value \"active\" or \"inactive\". Active companies are being monitored by Bitvore so news is being currently collected. An inactive company will need to be activated in order to start news collection. Simply adding an inactive company to your portfolio will not start news collection. If you see an inactive company you would like activated please contact [customer support](mailto:support@bitvore.com). \n\n ### Identification API \n\n The Identification API maps custom identifiers to Bitvore IDs so that the business portfolio does not have to be replicated in the Bitvore system. Portfolios typically reference companies using their own identification scheme. The portfolio will remain in an external store and only a mapping of the IDs of the companies using that identification scheme need be mapped to entities in the Bitvore system. This is only required for company based portfolios as no mapping is needed for CUSIPs. \n The API provides the ability to create, modify, and delete an ID map. The map consists of a list of ID mappings. Each mapping associates the external company ID with an internal Bitvore ID. \n\n  \n\n Once the map is created clients can invoke the Corporate News API using the IDs in their own identification scheme instead of Bitvore IDs. \n\n  \n\n The API client will provide a list of external IDs to the News API. The News API will find the Bitvore IDs for each external ID from the ID map created by the same API Client (as identified by their API key). The news is then returned for those associated Bitvore IDs. If there is no mapping in the system for an external ID an error will be returned.\n\n## Financial Filings API \n\n The financial filings submitted by companies or organizations in the Bitvore Knowledge Graph can be obtained through the Financial Filing API. \n\n Filings can be searched for based on filing type (8-K, 10-Q, etc.), company Bitvore ID, and time frame. The API provides the option of returning summary information about each filing such as the filing company information and filing type or returning the entire filing submission. Filing submissions consist of multiple files and will be returned in compressed file downloads. \n\n Filings queries are time based. The filings can be queried either within a specified time window or by a number of days back in history from the current day. The dates used when specifying a time window can be based on the submission date of a filing or the date which the filing was made available by the system. When using a polling strategy to query the latest filings using the API, the available date is recommended as submission dates can be less predictable. Due to the large number (and size) of filings that may be returned because of a broad criteria or a large window a limit on the number of filings to return by the system can be specified. \n\n Responses to summary queries are capped at 1000 filings while responses to submission queries are capped at 200. It is possible however that there are more than the capped amount of filings that match a given query. To accommodate queries that match more than the maximum size the concept of paging is supported. A page is a set of filings returned by a single query. It may be less than the total result set. The client can indicate which page they want returned on each call. This allows the client to loop through the result set one page at a time until the entire result set is returned. \n\n Both the page to return and the size of the page are specified by the client with the pageNo and pageSize parameters respectively. The API will list these parameter options as either query parameters or properties of the input message body. A query parameter example is as follows: \n\n ```js\n GET ...&pageNo=1&pageSize=100 HTTP 1.1\n ```\n \n\n This instructs the API to return the first page with a maximum of 100 filings in it. Each response will identify the number of filings returned for the current page and the total number of filings in the result set so the client can loop if needed. For example: \n\n ```js\n {\n \t\"success\": true,\n \t\"returned\": 100,\n \t\"total\": 1000, \n \t... \n ``` \n The above response indicates the requested page of 100 filings are in the response but there were a total of 1000 filings that matched the query. To then ask for the second page of the result set the pageNo parameter would be incremented as follows: \n\n ```js\n GET ...&pageNo=2&pageSize=100 HTTP 1.1\n ```\n \n\n In this example the next response will return the 101st to 200th filings in the result set. \n\n The Financial Filings API is part of the corporate data set and requires a corporate data set API key for access. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n## Score API \n\n The Score APIs provide access to the different scores Bitvore generates, such as company sentiment scores. Scores are calculated by gathering data over a period of time and aggregated in some manner to produce a numerical score that can be used to compare, trend, and correlate with other information. The scores are calculated periodically and are made available in a time series format by the APIs. \n\n The [Company Sentiment Score API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) provides scores measuring the sentiment about a company in regards to a given topic, such as a growth, risk, or an overall sentiment. The company sentiment score is calculated daily. Scores for each day are returned for each company requested over a given time period. \n\n The [Company Sentiment Score API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) uses the same API as the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n "
version: '1.0'
title: Bitvore Legacy Financial Filings API
license:
name: Copyright Bitvore Corp. 2026
servers:
- url: https://api.bitvore.com/
tags:
- name: Financial Filings
description: Financial Filings API
paths:
/financialfiling/submissions:
get:
tags:
- Financial Filings
summary: Financial Filings Submissions Query
description: "Returns full submissions for the financial filings that meet the supplied criteria. Financial filings can be selected with the following options: \n * Filing Type - Type of filing, i.e., 8-K, 10-Q, etc.\n * Bitvore ID - A Bitvore ID, known as a BvId, uniquely identifies a company/organization. Querying by BvId returns only filings submitted by that company.\n * Free Form Text Search - A search for words or phrases can be performed against the filings matching any of the previous options listed. \n * Include Summary - If set to true a summary file will be included with each submission with the fields described in the Get Summary operation. If false no summary file will be included. \n * Org Field - By default the subject company of a filing is identified by its ID and its name. Additional fields will be returned for each company if specified here. The available options are name, domainName, ticker, city, state, and country. If available the additional fields will be returned in the Org object in the summary. Note: Returning additional fields may cause a small increase in latency. This option is only applicable if summaries are included. \n \n\n This API operation is a file download operation. This call will download a compressed file holding the individual files from the original submission. Based on the Accept header provided by the client, the download file will either be a gzipped tar file (application/x-gzip) or a zip file (application/zip and the default). \n\n The following are some examples of using the API. \n\n To query for the filings submitted by IBM, BvId b00001ab7 within the last 30 days in the PST timezone using gzip compression (using query param for api key): \n\n ```js\n GET /financialfiling/submissions?bvId=b00001ab7&offset=30&tz=PST&key=xyz123 HTTP 1.1\n Accept: application/x-gzip\n ```\n \n\n To query for all the 10-Q filings submitted within the last 30 days in the PST timezone and return summary information: \n\n ```js\n GET /financialfiling/submissions?filingType=10-Q&includeSummary=true&offset=30&tz=PST&key=xyz123 HTTP 1.1\n Accept: application/gzip\n ```\n \n\n The file that is downloaded as a result of this call when decompressed (and extracted for the tar.gz option) will create a directory structure where each submission will get its own directory named with the key of the submission. All of the files that are part of the submission and the optional summary file will be placed in its directory. For example: \n\n ```\n 040000016b8b62e290bcb7e16fcb95b79000ad663679cbdb8566671c \n \tsummary.json \n \tjune2019slb8-k.htm \n \tex991june2019slb.htm \n \tbxclogoa43.jpg \n \t1301787/000130178719000056/0001301787-19-000056.txt \n 050000016b8b61adf8ad07fe0fd21063bd517de42f81fbfc5166671c \n \tsummary.json \n \teh1900853_8k.htm \n \teh1900853_ex0201.htm \n \teh1900853_ex1001.htm \n \t0000950142-19-001409.txt \n ```\n"
operationId: downloadFilingsUsingGET
parameters:
- name: filingType
in: query
description: Types of filings to return
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: bvId
in: query
description: Organizations of filings to return
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: includeSummary
in: query
description: Value of true will return a summary file with the filing files
required: false
allowEmptyValue: false
schema:
type: boolean
- name: text
in: query
description: Keyword or phrase to search for in the filings.
required: false
allowEmptyValue: false
schema:
type: string
- name: orgField
in: query
description: One or more fields to return for each organization associated with the returned articles, by default only the organization's Id and name is returned. Available options are name, domainName, ticker, city, state, country
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: startDate
in: query
description: Filing date to start from. Format is yyyy-mm-dd for daily filings or yyyy-mm-dd'T'HH:mm if you want it down to the hour or minute. Should not be used if offset parameter is.
required: false
allowEmptyValue: false
schema:
type: string
- name: endDate
in: query
description: Filing date to end with. Format is yyyy-mm-dd for daily (inclusive) filings or yyyy-mm-dd'T'HH:mm if you want it down to the hour or minute. If startDate is used and endDate is not the default endDate is today.
required: false
allowEmptyValue: false
schema:
type: string
- name: offset
in: query
description: Number of days back filings should be returned for. Should not be used with startDate. Default is 31.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
- name: tz
in: query
description: Timezone used in startDate and endDate.
required: false
allowEmptyValue: false
schema:
type: string
default: GMT
- name: dateType
in: query
description: Indicates whether dates to query by should be submission dates "submitted" or available dates (processing completed) "available". Default is submitted.
required: false
allowEmptyValue: false
schema:
type: string
default: submitted
- name: pageNo
in: query
description: Page number of the total result set to return, default is 1.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
description: Number of results out of the total result set per page to return, default is 100, maximum is 200.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: Success
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/InputStreamResource'
originalRef: InputStreamResource
application/zip:
schema:
$ref: '#/components/schemas/InputStreamResource'
originalRef: InputStreamResource
'401':
description: Unauthorized to view filings
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
application/zip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
application/zip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
/financialfiling/submissions/{filingId}:
get:
tags:
- Financial Filings
summary: Financial Filing Submission
description: "Returns the submission with the given key. The key is a unique identifier that can be found in the response to the Get Summaries call. This call will download a compressed file holding the individual files from the original submission. Based on the Accept header provided by the client, the download file will either be a gzipped tar file (application/x-gzip) or a zip file (application/zip and the default). \n\n An example of downloading a gzipped submission is \n\n ```js\n GET /financialfiling/submissions/060000016b9045f018c6e719ba884ef6605ccf6503a4733cf377651c HTTP 1.1\n Accept: application/x-gzip\n ```\n \n\n A sample successful response will be a gzipped tar file of the files from the original submission. If the submission was made to the SEC html files (with accompanying images) as well as a master text file will be included."
operationId: downloadFilingUsingGET
parameters:
- name: filingId
in: path
description: Bitore Id of the filing
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/InputStreamResource'
originalRef: InputStreamResource
application/zip:
schema:
$ref: '#/components/schemas/InputStreamResource'
originalRef: InputStreamResource
'401':
description: Unauthorized to view filing
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
application/zip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error
content:
application/x-gzip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
application/zip:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
/financialfiling/summaries:
get:
tags:
- Financial Filings
summary: Financial Filing Summaries Query
description: ${legacy.download.summaries.notes}
operationId: getFilingsUsingGET
parameters:
- name: filingType
in: query
description: Types of filings to return
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: bvId
in: query
description: Organizations of filings to return
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: text
in: query
description: Keyword or phrase to search for in the filings.
required: false
allowEmptyValue: false
schema:
type: string
- name: startDate
in: query
description: Filing date to start from. Format is yyyy-mm-dd for daily filings or yyyy-mm-dd'T'HH:mm if you want it down to the hour or minute. Should not be used if offset parameter is.
required: false
allowEmptyValue: false
schema:
type: string
- name: endDate
in: query
description: Filing date to end with. Format is yyyy-mm-dd for daily (inclusive) filings or yyyy-mm-dd'T'HH:mm if you want it down to the hour or minute. If startDate is used and endDate is not the default endDate is today.
required: false
allowEmptyValue: false
schema:
type: string
- name: offset
in: query
description: Number of days back filings should be returned for. Should not be used with startDate. Default is 31.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
- name: tz
in: query
description: Timezone used in startDate and endDate.
required: false
allowEmptyValue: false
schema:
type: string
default: GMT
- name: dateType
in: query
description: Indicates whether dates to query by should be submission dates "submitted" or available dates (processing completed) "available". Default is submitted.
required: false
allowEmptyValue: false
schema:
type: string
default: submitted
- name: orgField
in: query
description: One or more fields to return for each organization associated with the returned articles, by default only the organization's Id and name is returned. Available options are name, domainName, ticker, city, state, country
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: pageNo
in: query
description: Page number of the total result set to return, default is 1.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
description: Number of results out of the total result set per page to return, default is 100, maximum is 1000.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialFilingsSearchResponseLegacy'
originalRef: FinancialFilingsSearchResponseLegacy
'401':
description: Unauthorized to view filings
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
components:
schemas:
OrganizationReference:
type: object
properties:
bvId:
type: string
example: b00001ab7
description: Bitvore Id of the organization
city:
type: string
example: IRVINE
description: City the organization is headquartered in.
country:
type: string
example: UNITED STATES
description: Country the organization is headquartered in.
domainName:
type: string
example: acme.com
description: Domain name of the organization.
factsetId:
type: string
example: 000DWY-E
description: 'FactSet ID of the organization. (Requires License: ''FACTSET_ID'')'
isin:
type: string
example: US5949181045
description: 'ISIN of the organization. (Requires License: ''ISIN'')'
name:
type: string
example: ACME Corp
description: Name of the organization.
state:
type: string
example: CA
description: State (code) the organization is headquartered in.
ticker:
type: string
example: ACME
description: Primary ticker of the organization (if public).
title: OrganizationReference
description: Reference to an organization
URL:
type: object
properties:
authority:
type: string
content:
type: object
defaultPort:
type: integer
format: int32
file:
type: string
host:
type: string
path:
type: string
port:
type: integer
format: int32
protocol:
type: string
query:
type: string
ref:
type: string
userInfo:
type: string
title: URL
FinancialFilingLegacy:
type: object
properties:
availableAt:
type: string
example: '2017-06-29T21:41:21.109Z'
description: Date submitted
filingId:
type: string
description: Id of the filing unique to the filing source, the Id format may be different per source.
filingType:
type: string
example: 10-K
description: Type of the filing, i.e., 10-K, 8-Q
key:
type: string
example: 070000015cf083aba01f0826ecfe718e965b577c572166b14a77651c
description: Key uniquely identifying the filing in Bitvore
org:
description: Organization the filing is about.
$ref: '#/components/schemas/OrganizationReference'
originalRef: OrganizationReference
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitvore/refs/heads/main/openapi/bitvore-financial-filings-api-openapi.yml