{ "opencollection": "1.0.0", "info": { "name": "Corporate Filings API API", "version": "2.1" }, "items": [ { "info": { "name": "Filings API", "type": "folder" }, "items": [ { "info": { "name": "Financial Filings Submissions Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.bitvore.com/v2/corp/filings/financial/submissions", "params": [ { "name": "filingType", "value": "", "type": "query", "description": "Types of filings to return" }, { "name": "bvId", "value": "", "type": "query", "description": "Organizations of filings to return" }, { "name": "includeSummary", "value": "", "type": "query", "description": "Value of true will return a summary file with the filing files" }, { "name": "text", "value": "", "type": "query", "description": "Keyword or phrase to search for in the filings." }, { "name": "orgField", "value": "", "type": "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" }, { "name": "startDate", "value": "", "type": "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." }, { "name": "endDate", "value": "", "type": "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." }, { "name": "offset", "value": "", "type": "query", "description": "Number of days back filings should be returned for. Should not be used with startDate. Default is 31." }, { "name": "tz", "value": "", "type": "query", "description": "Timezone used in startDate and endDate." }, { "name": "dateType", "value": "", "type": "query", "description": "Indicates whether dates to query by should be submission dates \"submitted\" or available dates (processing completed) \"available\". Default is submitted." }, { "name": "pageNo", "value": "", "type": "query", "description": "Page number of the total result set to return, default is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results out of the total result set per page to return, default is 100, maximum is 200." } ] }, "docs": "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/" }, { "info": { "name": "Financial Filing Submission", "type": "http" }, "http": { "method": "GET", "url": "https://api.bitvore.com/v2/corp/filings/financial/submissions/:filingId", "params": [ { "name": "filingId", "value": "", "type": "path", "description": "The Id of the filing" } ] }, "docs": "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 w" }, { "info": { "name": "Financial Filing Summaries Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.bitvore.com/v2/corp/filings/financial/summaries", "params": [ { "name": "filingType", "value": "", "type": "query", "description": "Types of filings to return" }, { "name": "bvId", "value": "", "type": "query", "description": "Organizations of filings to return" }, { "name": "text", "value": "", "type": "query", "description": "Keyword or phrase to search for in the filings." }, { "name": "startDate", "value": "", "type": "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." }, { "name": "endDate", "value": "", "type": "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." }, { "name": "offset", "value": "", "type": "query", "description": "Number of days back filings should be returned for. Should not be used with startDate. Default is 31." }, { "name": "tz", "value": "", "type": "query", "description": "Timezone used in startDate and endDate." }, { "name": "dateType", "value": "", "type": "query", "description": "Indicates whether dates to query by should be submission dates \"submitted\" or available dates (processing completed) \"available\". Default is submitted." }, { "name": "orgField", "value": "", "type": "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" }, { "name": "pageNo", "value": "", "type": "query", "description": "Page number of the total result set to return, default is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results out of the total result set per page to return, default is 100, maximum is 1000." } ] }, "docs": "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." }, { "info": { "name": "Financial Filing", "type": "http" }, "http": { "method": "GET", "url": "https://api.bitvore.com/v2/corp/filings/financial/:filingId", "params": [ { "name": "filingId", "value": "", "type": "path", "description": "The Id of the filing" } ] }, "docs": "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_c" } ] } ], "bundled": true }