Package: sec-api
SEC API - A SEC.gov EDGAR Filings Query & Real-Time Stream APIsec-apiis a Python package allowing you to search the entire SEC filings corpus and access over 650 terabytes of data.It includes:SEC Filing Search and Full-Text Search APIReal-Time Stream APIXBRL-to-JSON Converter API + Financial Statements10-K/10-Q/8-K Section Extraction APIFiling Download & PDF Render APIExecutive Compensation Data APIInsider Trading Data API13F Institutional Investor DatabaseCUSIP/CIK/Ticker Mapping APIForm N-PORT APIForm D APIForm ADV APIForm 13D/13G APIFloat (Outstanding Shares) APISubsidiary APIData CoverageAll +18 million SEC EDGAR filings dating back to 1993 - 650,000 gigabyte of filings data.All +150 filing typesare supported, eg 10-Q, 10-K, 4, 8-K, 13-F, S-1, 424B4 and many more.See the list of supported form types here.Newly published filings are accessible in real-timeXBRL-to-JSON converter and parser API. Extract standardized financial statements from any 10-K and 10-Q filing.13F holdings API included. Monitor all institutional ownerships in real-time.Every filing ismapped to a CIK and tickerAll filings in JSON -no XBRL/XMLOverviewThe query API gives access to all over 18 million SEC Edgar filings ofover 8000publicly listed companies, ETFs, hedge funds, mutual funds, and investors dating back to 1993.Connect to the real-time stream API to receive new filings as soon as they are published on SEC EDGARThe full-text search API allows you to search the full text of all filings submitted since 2001. The full text of a filing includes all data in the filing itself as well as all attachments (such as exhibits) to the filing.Free API key available onsec-api.ioSee the official documentation for more:sec-api.io/docsInstallationpipinstallsec-apiGet your free API key onsec-api.ioand replaceYOUR_API_KEYwith it.SEC EDGAR Filings Query APIThe query API allows you to search and filter all 18 million filings published on SEC EDGAR.The example below retrieves all 10-Q filings filed by TSLA in 2020.fromsec_apiimportQueryApiqueryApi=QueryApi(api_key="YOUR_API_KEY")query={"query":{"query_string":{"query":"ticker:TSLA AND filedAt:{2020-01-01 TO 2020-12-31} AND formType:\"10-Q\""}},"from":"0","size":"10","sort":[{"filedAt":{"order":"desc"}}]}filings=queryApi.get_filings(query)print(filings)Fetch most recent 8-Ks with item 9.01query={"query":{"query_string":{"query":"formType:\"8-K\"AND description:\"9.01\""}},"from":"0","size":"10","sort":[{"filedAt":{"order":"desc"}}]}filings=queryApi.get_filings(query)13F Institutional Investor DatabaseFetch most recent 13F filings that hold Teslaquery={"query":{"query_string":{"query":"formType:\"13F\"AND holdings.cusip:88160R101"}},"from":"0","size":"10","sort":[{"filedAt":{"order":"desc"}}]}filings=queryApi.get_filings(query)See the documentation for more details:https://sec-api.io/docs/query-apiSEC EDGAR Filings Real-Time Stream APIThe stream API provides a live stream (aka feed) of newly published filings on SEC EDGAR.
A new filing is sent to your connected client as soon as it is published.Install thesocketioclient:pipinstallpython-engineio==3.14.2python-socketio[client]==4.6.0Run the example script below. Get your free API key onsec-api.ioand replaceYOUR_API_KEYwith it.importsocketiosio=socketio.Client()@sio.on("connect",namespace="/all-filings")defon_connect():print("Connected to https://api.sec-api.io:3334/all-filings")@sio.on("filing",namespace="/all-filings")defon_filings(filing):print(filing)sio.connect("https://api.sec-api.io:3334?apiKey=YOUR_API_KEY",namespaces=["/all-filings"],transports=["websocket"])sio.wait()Full-Text Search APIFull-text search allows you to search the full text of all EDGAR filings submitted since 2001. The full text of a filing includes all data in the filing itself as well as all attachments (such as exhibits) to the filing.The example below returns all 8-K and 10-Q filings and their exhibits, filed between 01-01-2021 and 14-06-2021, that include the exact phrase "LPCN 1154".fromsec_apiimportFullTextSearchApifullTextSearchApi=FullTextSearchApi(api_key="YOUR_API_KEY")query={"query":'"LPCN 1154"',"formTypes":['8-K','10-Q'],"startDate":'2021-01-01',"endDate":'2021-06-14',}filings=fullTextSearchApi.get_filings(query)print(filings)See the documentation for more details:https://sec-api.io/docs/full-text-search-apiXBRL-To-JSON Converter APIParse and standardize any XBRL and convert it to JSON or pandas dataframes. Extract financial statements and meta data from 10-K and 10-Q filings.The entire US GAAP taxonomy is fully supported. All XBRL items are fully converted into JSON, includingus-gaap,deiand custom items. XBRL facts are automatically mapped to their respective context including period instants and date ranges.All financial statements are accessible and standardized:StatementsOfIncomeStatementsOfIncomeParentheticalStatementsOfComprehensiveIncomeStatementsOfComprehensiveIncomeParentheticalBalanceSheetsBalanceSheetsParentheticalStatementsOfCashFlowsStatementsOfCashFlowsParentheticalStatementsOfShareholdersEquityStatementsOfShareholdersEquityParentheticalVariants such asConsolidatedStatementsofOperationsorConsolidatedStatementsOfLossIncomeare automatically standardized to their root name, e.g.StatementsOfIncome.Income Statement - Example Item{"StatementsOfIncome":{"RevenueFromContractWithCustomerExcludingAssessedTax":[{"decimals":"-6","unitRef":"usd","period":{"startDate":"2019-09-29","endDate":"2020-09-26"},"value":"274515000000"},{"decimals":"-6","unitRef":"usd","period":{"startDate":"2018-09-30","endDate":"2019-09-28"},"value":"260174000000"}]}}UsageThere are 3 ways to convert XBRL to JSON:htm_url: Provide the URL of the filing ending with.htm.
Example URL:https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htmxbrl_url: Provide the URL of the XBRL file ending with.xml. The XBRL file URL can be found in thedataFilesarray returned by our query API. The array item has the descriptionEXTRACTED XBRL INSTANCE DOCUMENTor similar.
Example URL:https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xmlaccession_no: Provide the accession number of the filing, e.g.0001564590-21-004599fromsec_apiimportXbrlApixbrlApi=XbrlApi("YOUR_API_KEY")# 10-K HTM File URL examplexbrl_json=xbrlApi.xbrl_to_json(htm_url="https://www.sec.gov/Archives/edgar/data/320193/000032019320000096/aapl-20200926.htm")# access income statement, balance sheet and cash flow statementprint(xbrl_json["StatementsOfIncome"])print(xbrl_json["BalanceSheets"])print(xbrl_json["StatementsOfCashFlows"])# 10-K XBRL File URL examplexbrl_json=xbrlApi.xbrl_to_json(xbrl_url="https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml")# 10-K accession number examplexbrl_json=xbrlApi.xbrl_to_json(accession_no="0001564590-21-004599")Example ResponseNote: response is shortened.{"CoverPage":{"DocumentPeriodEndDate":"2020-09-26","EntityRegistrantName":"Apple Inc.","EntityIncorporationStateCountryCode":"CA","EntityTaxIdentificationNumber":"94-2404110","EntityAddressAddressLine1":"One Apple Park Way","EntityAddressCityOrTown":"Cupertino","EntityAddressStateOrProvince":"CA","EntityAddressPostalZipCode":"95014","CityAreaCode":"408","LocalPhoneNumber":"996-1010","TradingSymbol":"AAPL","EntityPublicFloat":{"decimals":"-6","unitRef":"usd","period":{"instant":"2020-03-27"},"value":"1070633000000"},"EntityCommonStockSharesOutstanding":{"decimals":"-3","unitRef":"shares","period":{"instant":"2020-10-16"},"value":"17001802000"},"DocumentFiscalPeriodFocus":"FY","CurrentFiscalYearEndDate":"--09-26"},"StatementsOfIncome":{"RevenueFromContractWithCustomerExcludingAssessedTax":[{"decimals":"-6","unitRef":"usd","period":{"startDate":"2019-09-29","endDate":"2020-09-26"},"segment":{"dimension":"srt:ProductOrServiceAxis","value":"us-gaap:ProductMember"},"value":"220747000000"},{"decimals":"-6","unitRef":"usd","period":{"startDate":"2018-09-30","endDate":"2019-09-28"},"segment":{"dimension":"srt:ProductOrServiceAxis","value":"us-gaap:ProductMember"},"value":"213883000000"}]},"BalanceSheets":{"CashAndCashEquivalentsAtCarryingValue":[{"decimals":"-6","unitRef":"usd","period":{"instant":"2020-09-26"},"value":"38016000000"},{"decimals":"-6","unitRef":"usd","period":{"instant":"2019-09-28"},"value":"48844000000"},{"decimals":"-6","unitRef":"usd","period":{"instant":"2020-09-26"},"segment":{"dimension":"us-gaap:FinancialInstrumentAxis","value":"us-gaap:CashMember"},"value":"17773000000"}]}}See the documentation for more details:https://sec-api.io/docs/xbrl-to-json-converter-api10-K/10-Q/8-K Section Extractor APIThe Extractor API returns individual sections from 10-Q, 10-K and 8-K filings. The extracted section is cleaned and standardized - in raw text or in standardized HTML. You can programmatically extract one or multiple sections from any 10-Q, 10-K and 8-K filing.All 10-K sections can be extracted:1 - Business1A - Risk Factors1B - Unresolved Staff Comments2 - Properties3 - Legal Proceedings4 - Mine Safety Disclosures5 - Market for Registrant’s Common Equity, Related Stockholder Matters and Issuer Purchases of Equity Securities6 - Selected Financial Data (prior to February 2021)7 - Management’s Discussion and Analysis of Financial Condition and Results of Operations7A - Quantitative and Qualitative Disclosures about Market Risk8 - Financial Statements and Supplementary Data9 - Changes in and Disagreements with Accountants on Accounting and Financial Disclosure9A - Controls and Procedures9B - Other Information10 - Directors, Executive Officers and Corporate Governance11 - Executive Compensation12 - Security Ownership of Certain Beneficial Owners and Management and Related Stockholder Matters13 - Certain Relationships and Related Transactions, and Director Independence14 - Principal Accountant Fees and ServicesAll 10-Q sections can be extracted:Part 1:1 - Financial Statements2 - Management’s Discussion and Analysis of Financial Condition and Results of Operations3 - Quantitative and Qualitative Disclosures About Market Risk4 - Controls and ProceduresPart 2:1 - Legal Proceedings1A - Risk Factors2 -Unregistered Sales of Equity Securities and Use of Proceeds3 - Defaults Upon Senior Securities4 - Mine Safety Disclosures5 - Other Information6 - ExhibitsAll 8-K sections can be extracted:1.01: Entry into a Material Definitive Agreement1.02: Termination of a Material Definitive Agreement1.03: Bankruptcy or Receivership1.04: Mine Safety - Reporting of Shutdowns and Patterns of Violations2.01: Completion of Acquisition or Disposition of Assets2.02: Results of Operations and Financial Condition2.03: Creation of a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement of a Registrant2.04: Triggering Events That Accelerate or Increase a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement2.05: Cost Associated with Exit or Disposal Activities2.06: Material Impairments3.01: Notice of Delisting or Failure to Satisfy a Continued Listing Rule or Standard; Transfer of Listing3.02: Unregistered Sales of Equity Securities3.03: Material Modifications to Rights of Security Holders4.01: Changes in Registrant's Certifying Accountant4.02: Non-Reliance on Previously Issued Financial Statements or a Related Audit Report or Completed Interim Review5.01: Changes in Control of Registrant5.02: Departure of Directors or Certain Officers; Election of Directors; Appointment of Certain Officers: Compensatory Arrangements of Certain Officers5.03: Amendments to Articles of Incorporation or Bylaws; Change in Fiscal Year5.04: Temporary Suspension of Trading Under Registrant's Employee Benefit Plans5.05: Amendments to the Registrant's Code of Ethics, or Waiver of a Provision of the Code of Ethics5.06: Change in Shell Company Status5.07: Submission of Matters to a Vote of Security Holders5.08: Shareholder Nominations Pursuant to Exchange Act Rule 14a-116.01: ABS Informational and Computational Material6.02: Change of Servicer or Trustee6.03: Change in Credit Enhancement or Other External Support6.04: Failure to Make a Required Distribution6.04: Failure to Make a Required Distribution6.04: Failure to Make a Required Distribution6.05: Securities Act Updating Disclosure6.06: Static Pool6.10: Alternative Filings of Asset-Backed Issuers7.01: Regulation FD Disclosure8.01: Other Events9.01: Financial Statements and ExhibitsSignatureUsagefromsec_apiimportExtractorApiextractorApi=ExtractorApi("YOUR_API_KEY")## 10-K example## Tesla 10-K filingfiling_url_10k="https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm"# get the standardized and cleaned text of section 1A "Risk Factors"section_text=extractorApi.get_section(filing_url_10k,"1A","text")# get the original HTML of section 7 "Management’s Discussion and Analysis of Financial Condition and Results of Operations"section_html=extractorApi.get_section(filing_url_10k,"7","html")## 10-Q example## Tesla 10-Q filingfiling_url_10q="https://www.sec.gov/Archives/edgar/data/1318605/000095017022006034/tsla-20220331.htm"# extract section 1A "Risk Factors" in part 2 as cleaned textextracted_section_10q=extractorApi.get_section(filing_url_10q,"part2item1a","text")## 8-K example#filing_url_8k="https://www.sec.gov/Archives/edgar/data/66600/000149315222016468/form8-k.htm"# extract section 1.01 "Entry into Material Definitive Agreement" as cleaned textextracted_section_8k=extractorApi.get_section(filing_url_8k,"1-1","text")See the documentation for more details:https://sec-api.io/docs/sec-filings-item-extraction-apiFiling Render & Download APIUsed to download any filing or exhibit. You can process the downloaded filing in memory or save the filing to your hard drive.fromsec_apiimportRenderApirenderApi=RenderApi(api_key="YOUR_API_KEY")url="https://www.sec.gov/Archives/edgar/data/1662684/000110465921082303/tm2119986d1_8k.htm"filing=renderApi.get_filing(url)print(filing)See the documentation for more details:https://sec-api.io/docs/sec-filings-render-apiCUSIP/CIK/Ticker Mapping APIResolve a CUSIP, CIK, ticker symbol or company name to a set of standardized company details. Listing companies by exchange, sector and industry is also supported.Map any of the following parameters to company details:CUSIPCIKTickerCompany nameExchangeSectorIndustryThe function returns an array of all matching companies in JSON format. For example, a look up of the tickerIBMreturns multiple matches includingIBMDandIBME.A company object includes the following properties:name(string) - the name of the company, e.g. Tesla Incticker(string) - the ticker symbol of the company.cik(string) - the CIK of the company. Trailing zeros are removed.cusip(string) - one or multiple CUSIPs linked to the company. Multiple CUSIPs are delimited by space, e.g. "054748108 92931L302 92931L401"exchange(string) - the main exchange the company is listed on, e.g. NASDAQisDelisted(boolean) - true if the company is no longer listed, false otherwise.category(string) - the security category, e.g. "Domestic Common Stock"sector(string) - the sector of the company, e.g. "Consumer Cyclical"industry(string) - the industry of the company, e.g. "Auto Manufacturers"sic(string) - four-digit SIC code, e.g. "3711"sicSector(string) - SIC sector name of the company, e.g. "Manufacturing"sicIndustry(string) - SIC industry name of the company, e.g. "Motor Vehicles & Passenger Car Bodies"currency(string) - operating currency of the company, e.g. "USD"location(string) - location of the company's headquartersid(string) - unique internal ID of the company, e.g. "e27d6e9606f216c569e46abf407685f3"Response type:JSONUsagefromsec_apiimportMappingApimappingApi=MappingApi(api_key="YOUR_API_KEY")result1=mappingApi.resolve("ticker","TSLA")result2=mappingApi.resolve("cik","1318605")result3=mappingApi.resolve("cusip","88160R101")result4=mappingApi.resolve("exchange","NASDAQ")Response Example[{"name":"Tesla Inc","ticker":"TSLA","cik":"1318605","cusip":"88160R101","exchange":"NASDAQ","isDelisted":false,"category":"Domestic Common Stock","sector":"Consumer Cyclical","industry":"Auto Manufacturers","sic":"3711","sicSector":"Manufacturing","sicIndustry":"Motor Vehicles & Passenger Car Bodies","famaSector":"","famaIndustry":"Automobiles and Trucks","currency":"USD","location":"California; U.S.A","id":"e27d6e9606f216c569e46abf407685f3"}]See the documentation for more details:https://sec-api.io/docs/mapping-apiExecutive Compensation Data APIThe API provides standardized compensation data of all key executives as reported in SEC filing DEF 14A. The dataset is updated in real-time.You can search compensation data by 13 parameters, such as company ticker, executive name & position, annual salary, option awards and more.fromsec_apiimportExecCompApiexecCompApi=ExecCompApi("YOUR_API_KEY")# Get data by tickerresult_ticker=execCompApi.get_data("TSLA")# Get data by CIKresult_cik=execCompApi.get_data("789019")# List all exec compensations of CIK 70858 for year 2020 and 2019# Sort result by year first, by name secondquery={"query":{"query_string":{"query":"cik:70858 AND (year:2020 OR year:2019)"}},"from":"0","size":"200","sort":[{"year":{"order":"desc"}},{"name.keyword":{"order":"asc"}}],}result_query=execCompApi.get_data(query)Response Example[{"id":"8e9177e3bcdb30ada8d092c195bd9d63","cik":"1318605","ticker":"TSLA","name":"Andrew Baglino","position":"SVP, Powertrain and Energy Engineering","year":2020,"salary":283269,"bonus":0,"stockAwards":0,"optionAwards":46261354,"nonEquityIncentiveCompensation":0,"changeInPensionValueAndDeferredEarnings":0,"otherCompensation":0,"total":46544623}// and many more]See the documentation for more details:https://sec-api.io/docs/executive-compensation-apiInsider Trading Data APIThe Insider Trading Data API allows you to search and list all insider buy and sell transactions of all publicly listed
companies on US stock exchanges. Insider activities of company directors, officers, 10% owners and other executives are
fully searchable. The insider trading database includes information about the CIK and name of the insider,
her/his relationship to the company, the number of shares and securities purchased or sold, the purchase or selling price,
the date of the transaction, the amount of securities held before and after the transaction occured, any footnotes such
as the effect of Rule 10b-18 or 10b5-1 stock purchase plans and more. The full list of all data points is available below.fromsec_apiimportInsiderTradingApiinsiderTradingApi=InsiderTradingApi("YOUR_API_KEY")insider_trades=insiderTradingApi.get_data({"query":{"query_string":{"query":"issuer.tradingSymbol:TSLA"}}})print(insider_trades["transactions"])See the documentation for more details:https://sec-api.io/docs/insider-ownership-trading-apiResponse Example[{"accessionNo":"0000899243-22-028189","filedAt":"2022-08-09T21:23:00-04:00","documentType":"4","periodOfReport":"2022-08-09","issuer":{"cik":"1318605","name":"Tesla, Inc.","tradingSymbol":"TSLA"},"reportingOwner":{"cik":"1494730","name":"Musk Elon","address":{"street1":"C/O TESLA, INC.","street2":"1 TESLA ROAD","city":"AUSTIN","state":"TX","zipCode":"78725"},"relationship":{"isDirector":true,"isOfficer":true,"officerTitle":"CEO","isTenPercentOwner":true,"isOther":false}},"nonDerivativeTable":{"transactions":[{"securityTitle":"Common Stock","transactionDate":"2022-08-09","coding":{"formType":"4","code":"S","equitySwapInvolved":false},"amounts":{"shares":435,"pricePerShare":872.469,"pricePerShareFootnoteId":["F1"],"acquiredDisposedCode":"D"}}]// and many more}}]Form N-PORT APIAccess and find standardized N-PORT SEC filings.fromsec_apiimportFormNportApinportApi=FormNportApi("YOUR_API_KEY")response=nportApi.get_data({"query":{"query_string":{"query":"fundInfo.totAssets:[100000000 TO *]"}},"from":"0","size":"10","sort":[{"filedAt":{"order":"desc"}}],})print(response["filings"])See the documentation for more details:https://sec-api.io/docs/n-port-data-apiForm D APISearch and find Form D offering filings by any filing property, e.g. total offering amount, offerings filed by
hedge funds, type of securities offered and many more.fromsec_apiimportFormDApiformDApi=FormDApi("YOUR_API_KEY")response=formDApi.get_data({"query":{"query_string":{"query":"offeringData.offeringSalesAmounts.totalOfferingAmount:[1000000 TO *]"}},"from":"0","size":"10","sort":[{"filedAt":{"order":"desc"}}],})print(response["offerings"])See the documentation for more details:https://sec-api.io/docs/form-d-xml-json-apiForm ADV APISearch the entire ADV filing database and find all ADV filings filed by firm advisers (SEC and state registered),
individual advisers and firm brochures published in part 2 of ADV filings. The database comprises 41,000 ADV filings
filed by advisory firms and 380,000 individual advisers and is updated daily.
Search and find ADV filings by any filing property, such as CRD, assets under management,
type of adviser (e.g. broker dealer) and more. Direct owners from Schedule A, indirect owners from Schedule B as well as private funds from Schedule D are easily accessible.fromsec_apiimportFormAdvApiformAdvApi=FormAdvApi("YOUR_API_KEY")response=formAdvApi.get_firms({"query":{"query_string":{"query":"Info.FirmCrdNb:361"}},"from":"0","size":"10","sort":[{"Info.FirmCrdNb":{"order":"desc"}}],})print(response["filings"])direct_owners=formAdvApi.get_direct_owners(crd="793")print(direct_owners)indirect_owners=formAdvApi.get_indirect_owners(crd="326262")print(indirect_owners)private_funds=formAdvApi.get_private_funds(crd="793")print(private_funds)response=formAdvApi.get_individuals({"query":{"query_string":{"query":"CrntEmps.CrntEmp.orgPK:149777"}},"from":"0","size":"10","sort":[{"id":{"order":"desc"}}],})print(response["filings"])response=formAdvApi.get_brochures(149777)print(response["brochures"])See the documentation for more details:https://sec-api.io/docs/investment-adviser-and-adv-apiForm 13D/13G APIThe API allows you to easily search and access all SEC Form 13D and Form 13G filings in a standardized JSON format. You can search the database by any form field, such as the CUSIP of the acquired security, name of the security owner, or the aggregate amount owned in percetnage of total shares outstanding.fromsec_apiimportForm13DGApiform13DGApi=Form13DGApi("YOUR_API_KEY")# find the 50 most recently filed 13D/G filings disclosing 10% of more ownership of any Point72 company.query={"query":{"query_string":{"query":"owners.name:Point72 AND owners.amountAsPercent:[10 TO *]"}},"from":"0","size":"50","sort":[{"filedAt":{"order":"desc"}}]}response=form13DGApi.get_data(query)print(response["filings"])See the documentation for more details:https://sec-api.io/docs/form-13d-13g-search-apiResponse Example{"total":{"value":8,"relation":"eq"},"filings":[{"id":"bbb1ef1892bfc12a2e398c903871e3ae","accessionNo":"0000902664-22-005029","formType":"SC 13D","filedAt":"2022-12-05T16:00:20-05:00","filers":[{"cik":"1813658","name":"Tempo Automation Holdings, Inc. (Subject)"},{"cik":"1954961","name":"Point72 Private Investments, LLC (Filed by)"}],"nameOfIssuer":"Tempo Automation Holdings, Inc.","titleOfSecurities":"Common Stock, par value $0.0001 per share","cusip":["88024M108"],"eventDate":"2022-11-22","schedule13GFiledPreviously":false,"owners":[{"name":"Point72 Private Investments, LLC","memberOfGroup":{"a":false,"b":false},"sourceOfFunds":["OO"],"legalProceedingsDisclosureRequired":false,"place":"Delaware","soleVotingPower":0,"sharedVotingPower":5351000,"soleDispositivePower":0,"sharedDispositivePower":5351000,"aggregateAmountOwned":5351000,"amountExcludesCertainShares":false,"amountAsPercent":20.3,"typeOfReportingPerson":["OO"]}]}]}Float (Outstanding Shares) APIThe Float API returns the number of outstanding shares of any publicly traded company listed on US exchanges. The dataset includes the most recent float as well as historical float data. If a company registered multiple share classes, the API returns the number of shares outstanding of each class.fromsec_apiimportFloatApifloatApi=FloatApi("YOUR_API_KEY")response=floatApi.get_float(ticker="GOOGL")print(response["data"])response=floatApi.get_float(cik="1318605")print(response["data"])See the documentation for more details:https://sec-api.io/docs/outstanding-shares-float-apiResponse Example | Float API{"data":[{"tickers":["GOOGL","GOOG"],"cik":"1652044","reportedAt":"2023-02-02T21:23:45-05:00","periodOfReport":"2022-12-31","float":{"outstandingShares":[{"period":"2023-01-26","shareClass":"CommonClassA","value":5956000000},{"period":"2023-01-26","shareClass":"CommonClassB","value":883000000},{"period":"2023-01-26","shareClass":"CapitalClassC","value":5968000000}],"publicFloat":[{"period":"2022-06-30","shareClass":"","value":1256100000000}]},"sourceFilingAccessionNo":"0001652044-23-000016","id":"4a29432e1345e30a01e4aa10a2b57b62"}// and more...]}Subsidiary APIfromsec_apiimportSubsidiaryApisubsidiaryApi=SubsidiaryApi("YOUR_API_KEY")query={"query":{"query_string":{"query":"ticker:TSLA"}},"from":"0","size":"50","sort":[{"filedAt":{"order":"desc"}}],}response=subsidiaryApi.get_data(query)print(response["data"])See the documentation for more details:https://sec-api.io/docs/subsidiary-apiResponse Example | Subsidiary API{"data":[{"id":"6838a63b29128e116bde65c885282667","accessionNo":"0000950170-23-001409","filedAt":"2023-01-30T21:29:15-05:00","cik":"1318605","ticker":"TSLA","companyName":"Tesla, Inc.","subsidiaries":[{"name":"Alabama Service LLC","jurisdiction":"Delaware"}{"name":"Alset Warehouse GmbH","jurisdiction":"Germany"},{"name":"BT Connolly Storage, LLC","jurisdiction":"Texas"},{"name":"Fotovoltaica GI 4, S. de R.L. de C.V.","jurisdiction":"Mexico"},// ... more subsidiaries},// ... more historical lists of subsidiaries]}Proxy SupportIn certain cases, your corporate IT infrastructure may encounter issues with HTTPS requests, leading to SSL certificate errors. To resolve this, HTTP and HTTPS proxies can be passed into all API wrappers as shown in the example below. If you're unsure about which proxies to use, please consult your company's IT administrator.fromsec_apiimportQueryApi,RenderApi,...proxies={"http":"http://your-proxy.com","https":"https://your-proxy.com",}queryApi=QueryApi(api_key="YOUR_API_KEY",proxies=proxies)renderApi=RenderApi(api_key="YOUR_API_KEY",proxies=proxies)Query API Response FormataccessionNo(string) - Accession number of filing, e.g. 0000028917-20-000033cik(string) - CIK of the filing issuer. Important: trailing0are removed.ticker(string) - Ticker of company, e.g. AMOT. A ticker is not available when non-publicly traded companies report filings (e.g. form 4 reported by directors). Please contact us if you find filings that you think should have tickers (but don't).companyName(string) - Name of company, e.g. Allied Motion Technologies InccompanyNameLong(string) - Long version of company name including the filer type (Issuer, Filer, Reporting), e.g. ALLIED MOTION TECHNOLOGIES INC (0000046129) (Issuer)formType(string) - sec.gov form type, e.g 10-K.See the list of supported form types here.description(string) - Description of the form, e.g. Statement of changes in beneficial ownership of securitieslinkToFilingDetails(string) - Link to HTML, XML or PDF version of the filing.linkToTxt(string) - Link to the plain text version of the filing. This file can be multiple MBs large.linkToHtml(string) - Link to index page of the filing listing all exhibits and the original HTML file.linkToXbrl(string, optional) - Link to XBRL version of the filing (if available).filedAt(string) - The date (format: YYYY-MM-DD HH:mm:SS TZ) the filing was filed, eg 2019-12-06T14:41:26-05:00.periodOfReport(string, if reported) - Period of report, e.g. 2021-06-08effectivenessDate(string, if reported) - Effectiveness date, e.g. 2021-06-08id(string) - Unique ID of the filing.entities(array) - A list of all entities referred to in the filing. The first item in the array always represents the filing issuer. Each array element is an object with the following keys:companyName(string) - Company name of the entity, e.g. DILLARD'S, INC. (Issuer)cik(string) - CIK of the entity. Trailing 0 are not removed here, e.g. 0000028917irsNo(string, optional) - IRS number of the entity, e.g. 710388071stateOfIncorporation(string, optional) - State of incorporation of entity, e.g. ARfiscalYearEnd(string, optional) - Fiscal year end of the entity, e.g. 0201sic(string, optional) - SIC of the entity, e.g. 5311 Retail-Department Storestype(string, optional) - Type of the filing being filed. Same as formType, e.g. 4act(string, optional) - The SEC act pursuant to which the filing was filed, e.g. 34fileNo(string, optional) - Filer number of the entity, e.g. 001-06140filmNo(string, optional) - Film number of the entity, e.g. 20575664documentFormatFiles(array) - An array listing all primary files of the filing. The first item of the array is always the filing itself. The last item of the array is always the TXT version of the filing. All other items can represent exhibits, press releases, PDF documents, presentations, graphics, XML files, and more. An array item is represented as follows:sequence(string, optional) - The sequence number of the filing, e.g. 1description(string, optional) - Description of the file, e.g. EXHIBIT 31.1documentUrl(string) - URL to the file on SEC.govtype(string, optional) - Type of the file, e.g. EX-32.1, GRAPHIC or 10-Qsize(string, optional) - Size of the file, e.g. 6627216dataFiles(array) - List of data files (filing attachments, exhibits, XBRL files) attached to the filing.sequence(string) - Sequence number of the file, e.g. 6description(string) - Description of the file, e.g. XBRL INSTANCE DOCUMENTdocumentUrl(string) - URL to the file on SEC.govtype(string, optional) - Type of the file, e.g. EX-101.INS, EX-101.DEF or EX-101.PREsize(string, optional) - Size of the file, e.g. 6627216seriesAndClassesContractsInformation(array) - List of series and classes/contracts informationseries(string) - Series ID, e.g. S000001297name(string) - Name of entity, e.g. PRUDENTIAL ANNUITIES LIFE ASSUR CORP VAR ACCT B CL 1 SUB ACCTSclassesContracts(array) - List of classes/contracts. Each list item has the following keys:classContract(string) - Class/Contract ID, e.g. C000011787name(string) - Name of class/contract entity, e.g. Class Lticker(string) - Ticker class/contract entity, e.g. URTLX13F Institutional Ownerships13F filings report institutional ownerships. Each 13F filing has an attributeholdings(array). An array item in holdings represents one holding and has the following attributes:nameOfIssuer(string) - Name of issuer, e.g. MICRON TECHNOLOGY INCtitleOfClass(string) - Title of class, e.g. COMcusip(string) - CUSIP of security, e.g. 98850P109value(integer) - Absolute holding value in $, e.g. 18000. Note:valuedoesn't have to be multiplied by 1000 anymore. It's done by our API automatically.shrsOrPrnAmt(object)sshPrnamt(integer) - Shares or PRN AMT, e.g. 345sshPrnamtType(string) - Share/PRN type, e.g. "SH"putCall(string, optional) - Put / Call, e.g. PutinvestmentDiscretion(string) - Investment discretion, e.g. "SOLE"otherManager(string, optional) - Other manager, e.g. 7votingAuthority(object)Sole(integer) - Sole, e.g. 345Shared(integer) - Shared, e.g. 345None(integer) - None, e.g. 345Query API Example JSON Response{"id":"79ad9e452ea42402df4fe55c636191d6","accessionNo":"0001213900-21-032169","cik":"1824149","ticker":"JOFF","companyName":"JOFF Fintech Acquisition Corp.","companyNameLong":"JOFF Fintech Acquisition Corp. (Filer)","formType":"10-Q","description":"Form 10-Q - Quarterly report [Sections 13 or 15(d)]","filedAt":"2021-06-11T17:25:44-04:00","linkToTxt":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169.txt","linkToHtml":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169-index.htm","linkToXbrl":"","linkToFilingDetails":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321_jofffintech.htm","entities":[{"companyName":"JOFF Fintech Acquisition Corp. (Filer)","cik":"1824149","irsNo":"852863893","stateOfIncorporation":"DE","fiscalYearEnd":"1231","type":"10-Q","act":"34","fileNo":"001-40005","filmNo":"211012398","sic":"6770 Blank Checks"}],"documentFormatFiles":[{"sequence":"1","description":"QUARTERLY REPORT","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321_jofffintech.htm","type":"10-Q","size":"274745"},{"sequence":"2","description":"CERTIFICATION","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex31-1_jofffintech.htm","type":"EX-31.1","size":"12209"},{"sequence":"3","description":"CERTIFICATION","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex31-2_jofffintech.htm","type":"EX-31.2","size":"12220"},{"sequence":"4","description":"CERTIFICATION","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex32-1_jofffintech.htm","type":"EX-32.1","size":"4603"},{"sequence":"5","description":"CERTIFICATION","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex32-2_jofffintech.htm","type":"EX-32.2","size":"4607"},{"sequence":" ","description":"Complete submission text file","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169.txt","type":" ","size":"2344339"}],"dataFiles":[{"sequence":"6","description":"XBRL INSTANCE FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331.xml","type":"EX-101.INS","size":"248137"},{"sequence":"7","description":"XBRL SCHEMA FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331.xsd","type":"EX-101.SCH","size":"43550"},{"sequence":"8","description":"XBRL CALCULATION FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_cal.xml","type":"EX-101.CAL","size":"21259"},{"sequence":"9","description":"XBRL DEFINITION FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_def.xml","type":"EX-101.DEF","size":"182722"},{"sequence":"10","description":"XBRL LABEL FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_lab.xml","type":"EX-101.LAB","size":"309660"},{"sequence":"11","description":"XBRL PRESENTATION FILE","documentUrl":"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_pre.xml","type":"EX-101.PRE","size":"186873"}],"seriesAndClassesContractsInformation":[],"periodOfReport":"2021-03-31","effectivenessDate":"2021-03-31"}ContactLet us know how we can improve the library or if you have any feature
suggestions. We're happy to implement them.support@sec-api.io