Bitvore Filings API API

Financial Filings, Submissions and Summaries

OpenAPI Specification

bitvore-filings-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: "### Cellenus Corporate APIs\nThe Cellenus Corporate APIs consists of three main datasets, \"Corporate, Market & Industry\", \"ESG\", and \"Thematic Trending\" which provide news, events, press releases relevant to corporate entities, typically identifying signals that affect them. Bitvore currently surveils most public companies traded on US and international exchanges, US companies and international companies. Additionally, new companies required by a customer can be requested to be added to our surveillance.\n\nThe Corporate APIs also includes access to economic news for geographic locations in the United States.\n\nA typical record in the dataset is depicted below.\n\n![News Article](https://bitvorestaticassets.blob.core.windows.net/api-docs/corp-news-article.png)\n\nAccess to the Corporate Datasets using the Corporate APIs requires its own license and API key.  To register for an API Key please visit [here](http://developer.bitvore.com/v2/getting-started?section=obtain-api-key). \n\nThe Cellenus Corporate APIs, include [Corporate News API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API), [Ecomomic News](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API), [Organizations](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Organizations%20API), [Portfolio Integration](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Portfolios%20API), [Sentiment Scores](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Sentiment%20Scores%20API), [Financial Filings](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Filings%20API) and [Datasets](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Datasets%20API).\n\nThe [Corporate News API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API) provides direct access to the curated news based on company ID (Bitvore ID), portfolio, customer ID, industry, location, and certain company characteristics such as number of employees and annual revenue.\n\nThe [Economic News API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API) provides direct access to the curated news relevant to the economy of a location or region.\n\nThe [Organizations API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Organizations%20API) provides the ability to search for companies by a variety of company characteristics such as name, web domain, ticker, industry, location, number of employees, and annual revenue. Each company is uniquely identified by a Bitvore ID which can be used as input to query the [News API](http://developer.bitvore.com/v2/docs/overview).\n\nThe [Portfolios API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Portfolios%20API) provides the ability to either create and maintain portfolios of companies so that news can be queried in a single call from the [News API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API) for a given portfolio or to map your own company ID scheme to Bitvore's so you can query the [News API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=News%20API) with your own IDs.\n\nThe [Filings API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Filings%20API) provides direct access to the financial filings submitted to regulatory agencies such as the SEC on behalf of companies found in the [Organizations API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Organizations%20API).\n\nThe [Datasets API](http://developer.bitvore.com/v2/docs/overview/corp?tagname=Datasets%20API) provides dataset and changeset exporting. This API provides offline data consumption that can be used with external tools.\n\n"
  version: '2.1'
  title: Corporate Filings API API
  license:
    name: Copyright Bitvore Corp. 2026
servers:
- url: https://api.bitvore.com/
tags:
- name: Filings API
  description: Financial Filings, Submissions and Summaries
paths:
  /v2/corp/filings/financial/submissions:
    get:
      tags:
      - Filings API
      summary: Financial Filings Submissions Search
      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).  An example of downloading a gzipped submission is \n\n```js\n GET https://api.bitvore.com/v2/corp/filings/financial/submissions/060000016b9045f018c6e719ba884ef6605ccf6503a4733cf377651c\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: downloadFilingsUsingGET_1
      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
          content:
            application/x-gzip:
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
            application/zip:
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
        '500':
          description: Internal error
          content:
            application/x-gzip:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
            application/zip:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
      security:
      - API key:
        - Global
      - OAuth:
        - Global
      deprecated: true
  /v2/corp/filings/financial/submissions/{filingId}:
    get:
      tags:
      - Filings API
      summary: Financial Filing Submission
      description: "Returns full submission for the financial filing by filing id. 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\nThe 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 https://api.bitvore.com/v2/corp/filings/financial/submissions/70858-000148105721004046&key=xyz123\n ```\n \n\n"
      operationId: downloadFilingUsingGET_1
      parameters:
      - name: filingId
        in: path
        description: The 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
          content:
            application/x-gzip:
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
            application/zip:
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
        '500':
          description: Internal error
          content:
            application/x-gzip:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
            application/zip:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
      security:
      - API key:
        - Global
      - OAuth:
        - Global
      deprecated: true
  /v2/corp/filings/financial/summaries:
    get:
      tags:
      - Filings API
      summary: Financial Filing Summaries Search
      description: "Returns summary information 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 * 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. \n \n\nThe following are some examples of using the API. \n\nTo query for the filings submitted by IBM, BvID b00001ab7 within the last 30 days in the PST timezone (using query param for api key): \n\n```js\n GET https://api.bitvore.com/v2/corp/filings/financial/summaries?bvId=b00001ab7&offset=30&tz=PST&key=xyz123\n ```\n \n\nTo query for all the 10-Q filings submitted within the last 30 days in the PST timezone: \n\n```js\n GET https://api.bitvore.com/v2/corp/filings/financial/summaries?filingType=10-Q&offset=30&tz=PST&key=xyz123\n ```\n \n\nThe filing summaries are essentially a set of metadata about the filings themselves. The metadata fields are: \n * Key - A unique string identifying the submission in the Bitvore system. \n * Filing Type - The type of filing (i.e., 8-K, 10-Q, etc.). \n * Title - Title of the filing as reported by the regulatory agency. \n * Source URL - A URL to the filing provided by the regulatory agency. \n * Text - A text representation of the filing. For SEC filings this will be the text of the primary filing document only. * Org - A structure that holds identifying information about the company the filing is about. By default the structure will have the Bitvore ID and name of the company. Other fields may be included based on the Org Field parameter. \n * Available At - The date at which the filing was made available by the system. \n * Published At - The date the filing was submitted to the regulatory agency. \n \n\nA sample successful response is: \n\n```js\n {\n \t\"success\": true,\n \t\"returned\": 1,\n \t\"total\": 1,\n \t\"response\": [\n \t\t{\n \t\t\t\"key\": \"040000016b8b62e290bcb7e16fcb95b79000ad663679cbdb8566671c\",\n \t\t\t\"filingId\": \"70858-000148105721004046\",\n \t\t\t\"filingType\": \"8-K\",\n \t\t\t\"files\": [\"https://www.sec.gov/Archives/edgar/data/70858/000148105721004046/form424b2.htm\", \"https://www.sec.gov/Archives/edgar/data/70858/000148105721004046/image_cover.jpg\"],\n \t\t\t\"title\": \" 8-K - BlueLinx Holdings Inc. (0001301787) (Filer)\",\n \t\t\t\"sourceUrl\": \"https://www.sec.gov/Archives/edgar/data/1301787/000130178719000056/0001301787-19-000056-index.htm\",\n \t\t\t\"org\": { \"BvId\" : \"b0004hvv7\", \"Name\" : \"BlueLinx Holdings Inc\" }, \n \t\t\t\"publishedAt\": \"2019-06-24T21:41:19.109Z\",\n \t\t\t\"availableAt\": \"2017-06-24T21:41:21.109Z\",\n \t\t}\n \t]\n }\n ```\n "
      operationId: getFilingsUsingGET_1
      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/FinancialFilingsSearchResponse'
                originalRef: FinancialFilingsSearchResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
      security:
      - API key:
        - Global
      - OAuth:
        - Global
      deprecated: false
  /v2/corp/filings/financial/{filingId}:
    get:
      tags:
      - Filings API
      summary: Financial Filing
      description: "Returns a specific financial filing by id. \n\n```js\n GET https://api.bitvore.com/v2/corp/filings/financial/70858-000148105721004046&key=xyz123\n ```\n \n\nA sample successful response is: \n\n```js\n \t{\n \t\t\"key\": \"040000016b8b62e290bcb7e16fcb95b79000ad663679cbdb8566671c\",\n \t\t\"filingId\": \"70858-000148105721004046\",\n \t\t\"filingType\": \"8-K\",\n \t\t\"files\": [\"https://www.sec.gov/Archives/edgar/data/70858/000148105721004046/form424b2.htm\", \"https://www.sec.gov/Archives/edgar/data/70858/000148105721004046/image_cover.jpg\"],\n \t\t\"title\": \" 8-K - BlueLinx Holdings Inc. (0001301787) (Filer)\",\n \t\t\"sourceUrl\": \"https://www.sec.gov/Archives/edgar/data/1301787/000130178719000056/0001301787-19-000056-index.htm\",\n \t\t\"org\": { \"BvId\" : \"b0004hvv7\", \"Name\" : \"BlueLinx Holdings Inc\" }, \n \t\t\"publishedAt\": \"2019-06-24T21:41:19.109Z\",\n \t\t\"availableAt\": \"2017-06-24T21:41:21.109Z\",\n \t}\n ```\n "
      operationId: getFilingUsingGET
      parameters:
      - name: filingId
        in: path
        description: The Id of the filing
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FinancialFiling'
                originalRef: FinancialFiling
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccessDeniedResponse'
                originalRef: AccessDeniedResponse
        '500':
          description: Internal error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InternalErrorResponse'
                originalRef: InternalErrorResponse
      security:
      - API key:
        - Global
      - OAuth:
        - Global
      deprecated: false
components:
  schemas:
    InternalErrorResponse:
      type: object
      properties:
        reason:
          type: string
          example: internal_error
        reasonSupport:
          type: string
          example: An internal error occured.
        response:
          type: string
          example: INTERNAL_SERVER_ERROR
        success:
          type: boolean
          example: false
      title: InternalErrorResponse
    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
    FinancialFiling:
      type: object
      properties:
        availableAt:
          type: string
          example: '2017-06-29T21:41:21.109Z'
          description: Date submitted
        files:
          type: array
          description: Files related to the filing source.
          items:
            type: string
        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/Organization'
          originalRef: Organization
        publishedAt:
          type: string
          example: '2017-06-29T21:41:21.109Z'
          description: Date available
        sourceUrl:
          type: string
          example: https://www.sec.gov
          description: URL to the original source of the filing
        text:
          type: string
          description: Text of the primary section of the filing. Filings are initially in HTML, all markup is removed and remaining text is returned. No exhibits or addendums are included.
        title:
          type: string
          description: Title of the filing
      title: FinancialFiling
      description: A financial filing for an organization.
    Organization:
      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
        isin:
          type: string
          example: US5949181045
          description: 'ISIN of the organization. (Requires License: ''ISIN'')'
        listings:
          type: array
          description: The exchange listings of the organization.
          items:
            $ref: '#/components/schemas/Listing'
            originalRef: Listing
        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
          description: The primary ticker symbol the organization.
      title: Organization
    InputStreamResource:
      type: object
      properties:
        description:
          type: string
        file:
          $ref: '#/components/schemas/File'
          originalRef: File
        filename:
          type: string
        inputStream:
          $ref: '#/components/schemas/InputStream'
          originalRef: InputStream
        open:
          type: boolean
        readable:
          type: boolean
        uri:
          $ref: '#/components/schemas/URI'
          originalRef: URI
        url:
          $ref: '#/components/schemas/URL'
          originalRef: URL
      title: InputStreamResource
    File:
      type: object
      properties:
        absolute:
          type: boolean
        absoluteFile:
          $ref: '#/components/schemas/File'
          originalRef: File
        absolutePath:
          type: string
        canonicalFile:
          $ref: '#/components/schemas/File'
          originalRef: File
        canonicalPath:
          type: string
        directory:
          type: boolean
        file:
          type: boolean
        freeSpace:
          type: integer
          format: int64
        hidden:
          type: boolean
        name:
          type: string
        parent:
          type: string
        parentFile:
          $ref: '#/components/schemas/File'
          originalRef: File
        path:
          type: string
        totalSpace:
          type: integer
          format: int64
        usableSpace:
          type: integer
          format: int64
      title: File
    FinancialFilingsSearchResponse:
      type: object
      required:
      - returned
      - total
      properties:
        reason:
          type: string
          example: Could not locate subject.
          description: Text reason for the failure (if not successful)
        reasonSupport:
          type: string
          example: Longer description of the missing subject.
          description: Additional information about the failure (if not successful)
        response:
          type: array
          description: Response payload
          items:
            $ref: '#/components/schemas/FinancialFiling'
            originalRef: FinancialFiling
        returned:
          type: integer
          format: int32
          example: 10
          description: Number of filings returned by search, maximum amount dictated by the pageSize parameter used in search
        success:
          type: boolean
          example: true
          description: Indicates whether the call was successful or not
        total:
          type: integer
          format: int32
          example: 100
          description: Total number of financial filings found by search
      title: FinancialFilingsSearchResponse
      description: Financial filings search response.
    InputStream:
      type: object
      title: InputStream
    URI:
      type: object
      properties:
        absolute:
          type: boolean
        authority:
          type: string
        fragment:
          type: string
        host:
          type: string
        opaque:
          type: boolean
        path:
          type: string
        port:
          type: integer
          format: int32
        query:
          type: string
        rawAuthority:
          type: string
        rawFragment:
          type: string
        rawPath:
          type: string
        rawQuery:
          type: string
        rawSchemeSpecificPart:
          type: string
        rawUserInfo:
          type: string
        scheme:
          type: string
        schemeSpecificPart:
          type: string
        userInfo:
          type: string
      title: URI
    Listing:
      type: object
      properties:
        exchange:
          type: string
          example: NAS
          description: The exchange the ticker belongs to.
        mic:
          type: string
          example: XNAS
          description: The MIC code of the exchange
        region:
          type: string
          example: US
          description: The geographic region of the exchange
        ticker:
          type: string
          example: ACME
          description: Primary ticker symbol the organization.
      title: Listing
    AccessDeniedResponse:
      type: object
      properties:
        reason:
          type: string
          example: access_denied
        reasonSupport:
          type: string
          example: You are not authorized for this resource.
        response:
          type: string
          example: UNAUTHORIZED
        success:
          type: boolean
          example: false
      title: AccessDeniedResponse
  securitySchemes:
    API_key:
      type: apiKey
      name: X-BV-APIKEY
      in: header
    OAuth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            Global: Includes all Bitvore APIs
          tokenUrl: https://api.bitvore.com/oauth/accesstoken
x-info:
  description: Cellenus Corporate APIs, v2
  url: https://developer.bitvore.com
x-tagDescriptions:
  Datasets API: "## Datasets API \n\n The Datasets API provides two types of data that can be exported. These are Dataset and Changeset files. An API key is required to download the files.\n\n ## Dataset Files \n\n Datasets can be exported and downloaded in CSV file format. The dataset files holding data for the current year are updated once daily. \n\n Available Datasets:\n* Corporate Sentiment Scores \n * Corporate Signals \n * ESG Signals \n * Entities (Organizations) \n \n\n ### Corporate Sentiment Scores \n\n The Corporate Sentiment Scores file will contain the daily sentiment scores for an Organization. \n All scores are calculated based on input for 90 day moving windows. \n\n The scores calculated are the following:\n* sentiment - Overall corporate sentiment.\n* growth - Corporate sentiment strictly with regard to growth.\n* risk - Corporate sentiment strictly with regard to risk.\n\n\n There are two types of exports that are available; Yearly and Daily:\n\n * corp-sentiment-scores-2021.csv.gz - Yearly sentiment scores\n* corp-sentiment-scores-2021-05-04.csv.gz - Daily sentiment scores\n\n\n Example Request:\n\n ```js\nGET https://api.bitvore.com/v2/corp/datasets/corp-sentiment-scores/2021?key=xyz123\n ```\n \n\n Each file will have the following columns:\n* CompanyId - Bitvore ID that uniquely identifies the company that is the subject of the score(s).\n* CompanyName - Name of the company that is the subject of the score(s).\n* ScoreType - The type of sentiment score, \"growth\", \"risk\", \"sentiment\".\n* Score - The score value raging from -1.0 to 1.0.\n* Date - Date of the score.\n\n\n ### Corporate Signals \n\n The Corporate Signal Dataset consists of curated news, events, press releases, and filings that represent si

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitvore/refs/heads/main/openapi/bitvore-filings-api-api-openapi.yml