sec-api

Name	sec-api JSON
Version	1.0.25 JSON
	download
home_page	None
Summary	SEC EDGAR Filings API
upload_time	2024-10-16 15:05:32
maintainer	None
docs_url	None
author	SEC API
requires_python	None
license	None
keywords	sec edgar api sec filings api sec filing search api sec full-text search api edgar api finance cik cusip cusip to ticker cusip to cik 10-q 10-k 8-k s-1 424b4 xbrl converter financial statements api insider trading data executive compensation data form d offerings api form n-port api form adv api 10-k/10-q/8-k section extractor api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # SEC API - A SEC.gov EDGAR Filings Query & Real-Time Stream API

**sec-api** is a Python package allowing you to search the entire SEC EDGAR filings corpus and access petabytes of regulatory information published by public and private companies, insiders such as directors and board members, hedge and mutual funds, financial advisors, business development companies, and more.

It includes:

**EDGAR Filing Search & Download**

- [SEC Filing Search and Full-Text Search API](#sec-edgar-filings-query-api)
- [Real-Time Filing Stream API](#sec-edgar-filings-real-time-stream-api)
- [Filing Download & PDF Render API](#filing-render--download-api)
- [PDF Generator API](#pdf-generator-api)

**Converter & Extractor APIs:**

- [XBRL-to-JSON Converter API + Financial Statements](#xbrl-to-json-converter-api)
- [10-K/10-Q/8-K Section Extraction API](#10-k10-q8-k-section-extractor-api)

**Ownership Data APIs:**

- [Form 3/4/5 API - Insider Trading](#insider-trading-data-api)
- [Form 13F API - Institutional Investment Manager Holdings](#form-13f-institutional-holdings-database)
- [Form 13D/13G API - Activist and Passive Investor Holdings](#form-13d-13g-api)
- [Form N-PORT API - Mutual Fund Holdings](#form-n-port-api)

**Security Offerings APIs:**

- [Form S-1/424B4 API - Registration Statements and Prospectuses (IPOs, Debt/Warrants/... Offerings)](#form-s-1424b4-api)
- [Form D API - Private Security Offerings](#form-d-api)

**Investment Advisers:**

- [Form ADV API - Investment Advisors (Firm & Indvl. Advisors, Brochures, Schedules)](#form-adv-api)

**Structured Material Event Data from Form 8-K**

- [Financial Restatements & Non-Reliance on Prior Financial Results (Item 4.02)](#financial-restatements--non-reliance-on-prior-financial-results-item-402)

**Public Company Data**

- [Directors & Board Members API](#directors--board-members-data-api)
- [Executive Compensation Data API](#executive-compensation-data-api)
- [Outstanding Shares & Public Float](#outstanding-shares--public-float-api)
- [Company Subsidiary API](#subsidiary-api)

**Enforcement Actions & SRO Filings:**

- [AAER Database API - Accounting and Auditing Enforcement Releases](#aaer-database-api)
- [SRO Filings Database API](#sro-filings-database-api)

**Other APIs:**

- [CUSIP/CIK/Ticker Mapping API](#cusipcikticker-mapping-api)

## Data Coverage

- Access to over 18 million SEC EDGAR filings from 1993 to the present
- Supports all 150+ filing types, including 10-Q, 10-K, Form 4, 8-K, 13-F, S-1, 424B4, and many others. [See the full list of supported form types here.](https://sec-api.io/list-of-sec-filing-types)
- Real-time access to newly published filings.
- Includes XBRL-to-JSON converter and parser APIs for extracting standardized financial statements from any 10-K or 10-Q filing.
- 13F Holdings API provided, allowing real-time monitoring of institutional ownership.
- Every filing is linked to its corresponding CIK and ticker.
- All filings available in JSON format — no need for XBRL/XML parsing.

## Overview

- The Query API gives access to all over 18 million SEC EDGAR filings of over 8,000 publicly 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 EDGAR
- The 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 on [sec-api.io](https://sec-api.io)

See the official documentation for more: [sec-api.io/docs](https://sec-api.io/docs)

## Installation

```bash
pip install sec-api
```

Get your free API key on [sec-api.io](https://sec-api.io) and replace `YOUR_API_KEY` with it.

## SEC EDGAR Filings Query API

The Query API allows you to search and filter all 18 million filings and exhibits published on SEC EDGAR using a large set of search parameters. The database behind the Query API includes all EDGAR filing form types published since 1993 and over 800,000 EDGAR filer entities, with new filings being indexed and searchable as soon as they are published on SEC EDGAR.

You can search filings by ticker, CIK, form type, filing date, SIC code, period of report, series and class IDs, items of 8-K and other filings, and many more. The API returns all filing metadata in a [standardized JSON format](https://sec-api.io/docs/query-api#response-format).

Examples are provided below, in the [official documentation](https://sec-api.io/docs/query-api), and in our [sandbox](https://sec-api.io/sandbox).

### Examples

The following example retrieves all 10-Q filings filed by TSLA in 2020.

```python
from sec_api import QueryApi

queryApi = QueryApi(api_key="YOUR_API_KEY")

query = {
  "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)
```

Find the most recently reported Form 8-K filings that include Item 9.01 "Financial Statements and Exhibits".

```python
query = {
  "query": "formType:\"8-K\" AND items:\"9.01\"",
  "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-api

## Full-Text Search API

Full-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".

```python
from sec_api import FullTextSearchApi

fullTextSearchApi = 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-api

## Filing Render & Download API

Used to download any filing or exhibit. You can process the downloaded filing in memory or save the filing to your hard drive.

```python
from sec_api import RenderApi

renderApi = 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)

# for non-text data, such as a PDF files or an images,
# use get_file() and set `return_binary=True` to get the binary data
pdf_file_url = "https://www.sec.gov/Archives/edgar/data/1798925/999999999724004095/filename1.pdf"
binary_data = renderApi.get_file(pdf_file_url, return_binary=True)

with open("filename.pdf", "wb") as f:
    f.write(binary_data)
```

> See the documentation for more details: https://sec-api.io/docs/sec-filings-render-api

## PDF Generator API

SEC filings, including Forms 10-K, 10-Q, 8-K, and others, are typically published in HTML, XML, or text formats. The PDF Generator API enables the conversion of any SEC filing or exhibit into a PDF file, preserving all original formatting, tables, images, and other elements from the filing.

```python
from sec_api import PdfGeneratorApi

pdfGeneratorApi = PdfGeneratorApi("YOUR_API_KEY")

# Form 8-K exhibit URL
edgar_file_url = "https://www.sec.gov/ix?doc=/Archives/edgar/data/1320695/000132069520000148/ths12-31x201910krecast.htm"
# Form 10-K filing URL
# edgar_file_url = "https://www.sec.gov/Archives/edgar/data/320193/000032019320000096/aapl-20200926.htm"

pdf_file = pdfGeneratorApi.get_pdf(edgar_file_url)

with open("filename.pdf", "wb") as f:
    f.write(pdf_file)
```

> See the documentation for more details: https://sec-api.io/docs/sec-filings-render-api

## SEC EDGAR Filings Real-Time Stream API

The Stream API provides a live stream (aka feed) of newly published filings on SEC EDGAR via WebSockets. A new filing is sent to your connected client as soon as it is published.

---

Install the `websockets` client:

```bash
pip install websockets
```

Run the example script below. Get your free API key on [sec-api.io](https://sec-api.io) and replace `YOUR_API_KEY` with it.

```python
import asyncio
import websockets
import json

API_KEY = "YOUR_API_KEY" # Replace this with your actual API key
SERVER_URL = "wss://stream.sec-api.io"
WS_ENDPOINT = SERVER_URL + "?apiKey=" + API_KEY

async def websocket_client():
    try:
        async with websockets.connect(WS_ENDPOINT) as websocket:
            print("✅ Connected to:", SERVER_URL)

            while True:
                message = await websocket.recv()
                filings = json.loads(message)
                for f in filings:
                    print(f["accessionNo"], f["formType"], f["filedAt"], f["cik"])

    except Exception as e:
        print(f"An unexpected error occurred: {e}")


asyncio.run(websocket_client())
```

> See the documentation for more details: https://sec-api.io/docs/stream-api

## XBRL-To-JSON Converter API

Parse and standardize any XBRL and convert it to JSON or pandas dataframes. Extract financial statements and metadata from 10-K, 10-Q and any other SEC filing supporting XBRL.

The entire US GAAP taxonomy is fully supported. All XBRL items are fully converted into JSON, including `us-gaap`, `dei` and custom items. XBRL facts are automatically mapped to their respective context including period instants and date ranges.

All financial statements are accessible and standardized:

- StatementsOfIncome
- StatementsOfIncomeParenthetical
- StatementsOfComprehensiveIncome
- StatementsOfComprehensiveIncomeParenthetical
- BalanceSheets
- BalanceSheetsParenthetical
- StatementsOfCashFlows
- StatementsOfCashFlowsParenthetical
- StatementsOfShareholdersEquity
- StatementsOfShareholdersEquityParenthetical

Variants such as `ConsolidatedStatementsofOperations` or `ConsolidatedStatementsOfLossIncome` are automatically standardized to their root name, e.g. `StatementsOfIncome`.

### Income Statement - Example Item

```json
{
  "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"
      }
    ]
  }
}
```

### Usage

There 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.htm
- `xbrl_url`: Provide the URL of the XBRL file ending with `.xml`. The XBRL file URL can be found in the `dataFiles` array returned by our query API. The array item has the description `EXTRACTED XBRL INSTANCE DOCUMENT` or similar.
  Example URL: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml
- `accession_no`: Provide the accession number of the filing, e.g. `0001564590-21-004599`

```python
from sec_api import XbrlApi

xbrlApi = XbrlApi("YOUR_API_KEY")

# 10-K HTM File URL example
xbrl_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 statement
print(xbrl_json["StatementsOfIncome"])
print(xbrl_json["BalanceSheets"])
print(xbrl_json["StatementsOfCashFlows"])

# 10-K XBRL File URL example
xbrl_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 example
xbrl_json = xbrlApi.xbrl_to_json(accession_no="0001564590-21-004599")
```

### Example Response

Note: response is shortened.

```json
{
  "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-api

## 10-K/10-Q/8-K Section Extractor API

The 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 - Business
- 1A - Risk Factors
- 1B - Unresolved Staff Comments
- 1C - Cybersecurity (introduced in 2023)
- 2 - Properties
- 3 - Legal Proceedings
- 4 - Mine Safety Disclosures
- 5 - Market for Registrant’s Common Equity, Related Stockholder Matters and Issuer Purchases of Equity Securities
- 6 - Selected Financial Data (prior to February 2021)
- 7 - Management’s Discussion and Analysis of Financial Condition and Results of Operations
- 7A - Quantitative and Qualitative Disclosures about Market Risk
- 8 - Financial Statements and Supplementary Data
- 9 - Changes in and Disagreements with Accountants on Accounting and Financial Disclosure
- 9A - Controls and Procedures
- 9B - Other Information
- 10 - Directors, Executive Officers and Corporate Governance
- 11 - Executive Compensation
- 12 - Security Ownership of Certain Beneficial Owners and Management and Related Stockholder Matters
- 13 - Certain Relationships and Related Transactions, and Director Independence
- 14 - Principal Accountant Fees and Services

**All 10-Q sections can be extracted:**

Part 1:

- 1 - Financial Statements
- 2 - Management’s Discussion and Analysis of Financial Condition and Results of Operations
- 3 - Quantitative and Qualitative Disclosures About Market Risk
- 4 - Controls and Procedures

Part 2:

- 1 - Legal Proceedings
- 1A - Risk Factors
- 2 -Unregistered Sales of Equity Securities and Use of Proceeds
- 3 - Defaults Upon Senior Securities
- 4 - Mine Safety Disclosures
- 5 - Other Information
- 6 - Exhibits

**All 8-K sections can be extracted:**

- 1.01: Entry into a Material Definitive Agreement
- 1.02: Termination of a Material Definitive Agreement
- 1.03: Bankruptcy or Receivership
- 1.04: Mine Safety - Reporting of Shutdowns and Patterns of Violations
- 1.05: Material Cybersecurity Incidents (introduced in 2023)
- 2.01: Completion of Acquisition or Disposition of Assets
- 2.02: Results of Operations and Financial Condition
- 2.03: Creation of a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement of a Registrant
- 2.04: Triggering Events That Accelerate or Increase a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement
- 2.05: Cost Associated with Exit or Disposal Activities
- 2.06: Material Impairments
- 3.01: Notice of Delisting or Failure to Satisfy a Continued Listing Rule or Standard; Transfer of Listing
- 3.02: Unregistered Sales of Equity Securities
- 3.03: Material Modifications to Rights of Security Holders
- 4.01: Changes in Registrant's Certifying Accountant
- 4.02: Non-Reliance on Previously Issued Financial Statements or a Related Audit Report or Completed Interim Review
- 5.01: Changes in Control of Registrant
- 5.02: Departure of Directors or Certain Officers; Election of Directors; Appointment of Certain Officers: Compensatory Arrangements of Certain Officers
- 5.03: Amendments to Articles of Incorporation or Bylaws; Change in Fiscal Year
- 5.04: Temporary Suspension of Trading Under Registrant's Employee Benefit Plans
- 5.05: Amendments to the Registrant's Code of Ethics, or Waiver of a Provision of the Code of Ethics
- 5.06: Change in Shell Company Status
- 5.07: Submission of Matters to a Vote of Security Holders
- 5.08: Shareholder Nominations Pursuant to Exchange Act Rule 14a-11
- 6.01: ABS Informational and Computational Material
- 6.02: Change of Servicer or Trustee
- 6.03: Change in Credit Enhancement or Other External Support
- 6.04: Failure to Make a Required Distribution
- 6.05: Securities Act Updating Disclosure
- 6.06: Static Pool
- 6.10: Alternative Filings of Asset-Backed Issuers
- 7.01: Regulation FD Disclosure
- 8.01: Other Events
- 9.01: Financial Statements and Exhibits
- Signature

### Usage

```python
from sec_api import ExtractorApi

extractorApi = ExtractorApi("YOUR_API_KEY")

#
# 10-K example
#
# Tesla 10-K filing
filing_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 filing
filing_url_10q = "https://www.sec.gov/Archives/edgar/data/1318605/000095017022006034/tsla-20220331.htm"

# extract section 1A "Risk Factors" in part 2 as cleaned text
extracted_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 text
extracted_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-api

## Form ADV API

Search the entire Form 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.

```python
from sec_api import FormAdvApi

formAdvApi = FormAdvApi("YOUR_API_KEY")

response = formAdvApi.get_firms(
    {
        "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": "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-api

## Insider Trading Data API

The 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.

```python
from sec_api import InsiderTradingApi

insiderTradingApi = InsiderTradingApi("YOUR_API_KEY")

insider_trades = insiderTradingApi.get_data({
  "query": "issuer.tradingSymbol:TSLA"
})

print(insider_trades["transactions"])
```

> See the documentation for more details: https://sec-api.io/docs/insider-ownership-trading-api

### Response Example

```json
[
  {
    "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 13F Institutional Holdings Database

Find the most recently disclosed Form 13F filings that include Tesla as a holding.

```python
from sec_api import QueryApi

queryApi = QueryApi(api_key="YOUR_API_KEY")

query = {
  "query": "formType:\"13F\" AND holdings.ticker:TSLA",
  "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-api/13f-institutional-ownership-api

## Form 13D/13G API

The 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.

```python
from sec_api import Form13DGApi

form13DGApi = Form13DGApi("YOUR_API_KEY")

# find the 50 most recently filed 13D/G filings disclosing 10% of more ownership of any Point72 company.
query = {
    "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-api

### Response Example

```json
{
  "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"]
        }
      ]
    }
  ]
}
```

## Form N-PORT API

Access and find standardized N-PORT SEC filings.

```python
from sec_api import FormNportApi

nportApi = FormNportApi("YOUR_API_KEY")

response = nportApi.get_data(
    {
        "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-api

## Form S-1/424B4 API

Access and find structured and standardized data extracted from S-1, F-1, and S-11 registration statements as well as 424B4 prospectus filings. The JSON data includes public offering prices, underwriting discounts, proceeds before expenses, security types being offered, underwriters (lead and co-managers), law firms, auditors, employee counts and management information (name, age, position).

```python
from sec_api import Form_S1_424B4_Api

form_s1_424B4_api = Form_S1_424B4_Api("YOUR_API_KEY")

query = {
    "query": "ticker:V",
    "from": "0",
    "size": "50",
    "sort": [{"filedAt": {"order": "desc"}}],
}

response = form_s1_424B4_api.get_data(query)
print(response["data"])
```

> See the documentation for more details: https://sec-api.io/docs/form-s1-424b4-data-search-api

## Form D API

Search 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.

```python
from sec_api import FormDApi

formDApi = FormDApi("YOUR_API_KEY")

response = formDApi.get_data(
    {
        "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-api

## Financial Restatements & Non-Reliance on Prior Financial Results (Item 4.02)

Access and search all financial restatements and non-reliance on prior financial results filings from 2004 to present. The database includes information about the CIK, ticker and company name the restatement is associated with, the publication date of the restatement, list of identified issues, affected reporting periods that require restatement, affected financial statement items, auditor involvement, and more.

```python
from sec_api import Item_4_02_Api

item_4_02_api = Item_4_02_Api("YOUR_API_KEY")

query = {
    "query": "ticker:*",
    "from": "0",
    "size": "50",
    "sort": [{"filedAt": {"order": "desc"}}],
}

response = item_4_02_api.get_data(query)
print(response["data"])
```

> See the documentation for more details: https://sec-api.io/docs/form-8k-data-search-api

## Directors & Board Members Data API

Access and search the entire database of all directors and board members of all publicly listed companies on US stock exchanges. The database includes information about the CIK, ticker and company name the director is associated with, the name of the director, her/his age, position, director class, date of first election, independence status, committee memberships as well as qualifications and experiences.

```python
from sec_api import DirectorsBoardMembersApi

directorsBoardMembersApi = DirectorsBoardMembersApi("YOUR_API_KEY")

query = {
    "query": "ticker:AMZN",
    "from": 0,
    "size": 50,
    "sort": [{"filedAt": {"order": "desc"}}],
}

response = directorsBoardMembersApi.get_data(query)
print(response["data"])
```

> See the documentation for more details: https://sec-api.io/docs/directors-and-board-members-data-api

## Executive Compensation Data API

The 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.

```python
from sec_api import ExecCompApi

execCompApi = ExecCompApi("YOUR_API_KEY")

# Get data by ticker
result_ticker = execCompApi.get_data("TSLA")

# Get data by CIK
result_cik = execCompApi.get_data("789019")

# List all exec compensations of CIK 70858 for year 2020 and 2019
# Sort result by year first, by name second
query = {
    "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

```json
[
  {
    "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-api

## Outstanding Shares & Public Float API

The Float API returns the number of outstanding shares and public float of any publicly traded company listed on US exchanges. The dataset includes the most recently reported number of outstanding shares and float as well as historical data. If a company registered multiple share classes, the API returns the number of shares outstanding of each class.

```python
from sec_api import FloatApi

floatApi = 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-api

### Response Example | Float API

```json
{
  "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 API

```python
from sec_api import SubsidiaryApi

subsidiaryApi = SubsidiaryApi("YOUR_API_KEY")

query = {
    "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-api

### Response Example | Subsidiary API

```json
{
  "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
  ]
}
```

## AAER Database API

Access and search the Accounting and Auditing Enforcement Releases (AAER) database. The database includes all AAERs filed from 1997 to present.

```python
from sec_api import AaerApi

aaerApi = AaerApi("YOUR_API_KEY")

query = {
    "query": "dateTime:[2012-01-01 TO 2020-12-31]",
    "from": "0",
    "size": "50",
    "sort": [{"dateTime": {"order": "desc"}}],
}

response = aaerApi.get_data(query)
print(response["data"])
```

> See the documentation for more details: https://sec-api.io/docs/aaer-database-api

## SRO Filings Database API

Access and search all SRO filings published from 1995 to present. The database includes more than 30,000 SRO filings from all types of organizations, including National Securities Exchanges (NYSE, NASDAQ, CBOE, etc.), Joint Industry Plans, FINRA, Futures Exchanges (CME, CBOT, etc.), and more.

```python
from sec_api import SroFilingsApi

sroFilingsApi = SroFilingsApi("YOUR_API_KEY")

query = {
    "query": "sro:NASDAQ",
    "from": "0",
    "size": "10",
    "sort": [{"issueDate": {"order": "desc"}}],
}

response = sroFilingsApi.get_data(query)
print(response["data"])
```

> See the documentation for more details: https://sec-api.io/docs/sro-filings-database-api

## CUSIP/CIK/Ticker Mapping API

Resolve 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:

- CUSIP
- CIK
- Ticker
- Company name
- Exchange
- Sector
- Industry

The function returns an array of all matching companies in JSON format. For example, a look up of the ticker `IBM` returns multiple matches including `IBMD` and `IBME`.

A company object includes the following properties:

- `name` (string) - the name of the company, e.g. Tesla Inc
- `ticker` (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. NASDAQ
- `isDelisted` (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 headquarters
- `id` (string) - unique internal ID of the company, e.g. "e27d6e9606f216c569e46abf407685f3"

Response type: `JSON`

### Usage

```python
from sec_api import MappingApi

mappingApi = 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

```json
[
  {
    "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-api

## Proxy Support

In 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.

```python
from sec_api import QueryApi, 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 Format

- `accessionNo` (string) - Accession number of filing, e.g. 0000028917-20-000033
- `cik` (string) - CIK of the filing issuer. Important: trailing `0` are 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 Inc
- `companyNameLong` (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.](https://sec-api.io/#list-of-sec-form-types)
- `description` (string) - Description of the form, e.g. Statement of changes in beneficial ownership of securities
- `linkToFilingDetails` (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-08
- `effectivenessDate` (string, if reported) - Effectiveness date, e.g. 2021-06-08
- `registrationForm` (string, if reported) - Registration form as reported on EFFECT forms, e.g. S-1
- `referenceAccessionNo` (string, if reported) - Reference accession number as reported on EFFECT forms, e.g. 0001213900-22-001446
- `items` (array of strings, if reported) - Items represents an array of item strings as reported on form 8-K, 8-K/A, D, D/A, ABS-15G, ABS-15G/A, 1-U, 1-U/A. For example: `["Item 3.02: Unregistered Sales of Equity Securities", "Item 9.01: Financial Statements and Exhibits"]`
- `groupMembers` (array, if reported) - Group members represents an array of member strings as reported on SC 13G, SC 13G/A, SC 13D, SC 13D/A filings, e.g. `[ "ALEC N. LITOWITZMAGNETAR CAPITAL PARTNERS LPSUPERNOVA MANAGEMENT LLC" ]`
- `id` (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. 0000028917
  - `irsNo` (string, optional) - IRS number of the entity, e.g. 710388071
  - `stateOfIncorporation` (string, optional) - State of incorporation of entity, e.g. AR
  - `fiscalYearEnd` (string, optional) - Fiscal year end of the entity, e.g. 0201
  - `sic` (string, optional) - SIC of the entity, e.g. 5311 Retail-Department Stores
  - `type` (string, optional) - Type of the filing being filed. Same as formType, e.g. 4
  - `act` (string, optional) - The SEC act pursuant to which the filing was filed, e.g. 34
  - `fileNo` (string, optional) - Filer number of the entity, e.g. 001-06140
  - `filmNo` (string, optional) - Film number of the entity, e.g. 20575664
- `documentFormatFiles` (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. 1
  - `description` (string, optional) - Description of the file, e.g. EXHIBIT 31.1
  - `documentUrl` (string) - URL to the file on SEC.gov
  - `type` (string, optional) - Type of the file, e.g. EX-32.1, GRAPHIC or 10-Q
  - `size` (string, optional) - Size of the file, e.g. 6627216
- `dataFiles` (array) - List of data files (filing attachments, exhibits, XBRL files) attached to the filing.
  - `sequence` (string) - Sequence number of the file, e.g. 6
  - `description` (string) - Description of the file, e.g. XBRL INSTANCE DOCUMENT
  - `documentUrl` (string) - URL to the file on SEC.gov
  - `type` (string, optional) - Type of the file, e.g. EX-101.INS, EX-101.DEF or EX-101.PRE
  - `size` (string, optional) - Size of the file, e.g. 6627216
- `seriesAndClassesContractsInformation` (array) - List of series and classes/contracts information
  - `series` (string) - Series ID, e.g. S000001297
  - `name` (string) - Name of entity, e.g. PRUDENTIAL ANNUITIES LIFE ASSUR CORP VAR ACCT B CL 1 SUB ACCTS
  - `classesContracts` (array) - List of classes/contracts. Each list item has the following keys:
    - `classContract` (string) - Class/Contract ID, e.g. C000011787
    - `name` (string) - Name of class/contract entity, e.g. Class L
    - `ticker` (string) - Ticker class/contract entity, e.g. URTLX

### 13F Institutional Ownerships

13F filings report institutional ownerships. Each 13F filing has an attribute `holdings` (array). An array item in holdings represents one holding and has the following attributes:

- `nameOfIssuer` (string) - Name of issuer, e.g. MICRON TECHNOLOGY INC
- `titleOfClass` (string) - Title of class, e.g. COM
- `cusip` (string) - CUSIP of security, e.g. 98850P109
- `value` (integer) - Absolute holding value in $, e.g. 18000. Note: `value` doesn'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. 345
  - `sshPrnamtType` (string) - Share/PRN type, e.g. "SH"
- `putCall` (string, optional) - Put / Call, e.g. Put
- `investmentDiscretion` (string) - Investment discretion, e.g. "SOLE"
- `otherManager` (string, optional) - Other manager, e.g. 7
- `votingAuthority` (object)
  - `Sole` (integer) - Sole, e.g. 345
  - `Shared` (integer) - Shared, e.g. 345
  - `None` (integer) - None, e.g. 345

### Query API Example JSON Response

```json
{
  "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"
}
```

## Contact

Let 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



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sec-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "SEC EDGAR API, SEC Filings API, SEC Filing Search API, SEC Full-Text Search API, EDGAR API, Finance, CIK, CUSIP, CUSIP to Ticker, CUSIP to CIK, 10-Q, 10-K, 8-K, S-1, 424B4, XBRL Converter, Financial Statements API, Insider Trading Data, Executive Compensation Data, Form D Offerings API, Form N-PORT API, Form ADV API, 10-K/10-Q/8-K Section Extractor API",
    "author": "SEC API",
    "author_email": "support@sec-api.io",
    "download_url": "https://files.pythonhosted.org/packages/5e/08/a618a12b604fa6e3142683e48478404deed7e77c8088c8ad5b1264475e05/sec-api-1.0.25.tar.gz",
    "platform": null,
    "description": "# SEC API - A SEC.gov EDGAR Filings Query & Real-Time Stream API\n\n**sec-api** is a Python package allowing you to search the entire SEC EDGAR filings corpus and access petabytes of regulatory information published by public and private companies, insiders such as directors and board members, hedge and mutual funds, financial advisors, business development companies, and more.\n\nIt includes:\n\n**EDGAR Filing Search & Download**\n\n- [SEC Filing Search and Full-Text Search API](#sec-edgar-filings-query-api)\n- [Real-Time Filing Stream API](#sec-edgar-filings-real-time-stream-api)\n- [Filing Download & PDF Render API](#filing-render--download-api)\n- [PDF Generator API](#pdf-generator-api)\n\n**Converter & Extractor APIs:**\n\n- [XBRL-to-JSON Converter API + Financial Statements](#xbrl-to-json-converter-api)\n- [10-K/10-Q/8-K Section Extraction API](#10-k10-q8-k-section-extractor-api)\n\n**Ownership Data APIs:**\n\n- [Form 3/4/5 API - Insider Trading](#insider-trading-data-api)\n- [Form 13F API - Institutional Investment Manager Holdings](#form-13f-institutional-holdings-database)\n- [Form 13D/13G API - Activist and Passive Investor Holdings](#form-13d-13g-api)\n- [Form N-PORT API - Mutual Fund Holdings](#form-n-port-api)\n\n**Security Offerings APIs:**\n\n- [Form S-1/424B4 API - Registration Statements and Prospectuses (IPOs, Debt/Warrants/... Offerings)](#form-s-1424b4-api)\n- [Form D API - Private Security Offerings](#form-d-api)\n\n**Investment Advisers:**\n\n- [Form ADV API - Investment Advisors (Firm & Indvl. Advisors, Brochures, Schedules)](#form-adv-api)\n\n**Structured Material Event Data from Form 8-K**\n\n- [Financial Restatements & Non-Reliance on Prior Financial Results (Item 4.02)](#financial-restatements--non-reliance-on-prior-financial-results-item-402)\n\n**Public Company Data**\n\n- [Directors & Board Members API](#directors--board-members-data-api)\n- [Executive Compensation Data API](#executive-compensation-data-api)\n- [Outstanding Shares & Public Float](#outstanding-shares--public-float-api)\n- [Company Subsidiary API](#subsidiary-api)\n\n**Enforcement Actions & SRO Filings:**\n\n- [AAER Database API - Accounting and Auditing Enforcement Releases](#aaer-database-api)\n- [SRO Filings Database API](#sro-filings-database-api)\n\n**Other APIs:**\n\n- [CUSIP/CIK/Ticker Mapping API](#cusipcikticker-mapping-api)\n\n## Data Coverage\n\n- Access to over 18 million SEC EDGAR filings from 1993 to the present\n- Supports all 150+ filing types, including 10-Q, 10-K, Form 4, 8-K, 13-F, S-1, 424B4, and many others. [See the full list of supported form types here.](https://sec-api.io/list-of-sec-filing-types)\n- Real-time access to newly published filings.\n- Includes XBRL-to-JSON converter and parser APIs for extracting standardized financial statements from any 10-K or 10-Q filing.\n- 13F Holdings API provided, allowing real-time monitoring of institutional ownership.\n- Every filing is linked to its corresponding CIK and ticker.\n- All filings available in JSON format \u2014 no need for XBRL/XML parsing.\n\n## Overview\n\n- The Query API gives access to all over 18 million SEC EDGAR filings of over 8,000 publicly listed companies, ETFs, hedge funds, mutual funds, and investors dating back to 1993.\n- Connect to the real-time stream API to receive new filings as soon as they are published on SEC EDGAR\n- The 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.\n- Free API key available on [sec-api.io](https://sec-api.io)\n\nSee the official documentation for more: [sec-api.io/docs](https://sec-api.io/docs)\n\n## Installation\n\n```bash\npip install sec-api\n```\n\nGet your free API key on [sec-api.io](https://sec-api.io) and replace `YOUR_API_KEY` with it.\n\n## SEC EDGAR Filings Query API\n\nThe Query API allows you to search and filter all 18 million filings and exhibits published on SEC EDGAR using a large set of search parameters. The database behind the Query API includes all EDGAR filing form types published since 1993 and over 800,000 EDGAR filer entities, with new filings being indexed and searchable as soon as they are published on SEC EDGAR.\n\nYou can search filings by ticker, CIK, form type, filing date, SIC code, period of report, series and class IDs, items of 8-K and other filings, and many more. The API returns all filing metadata in a [standardized JSON format](https://sec-api.io/docs/query-api#response-format).\n\nExamples are provided below, in the [official documentation](https://sec-api.io/docs/query-api), and in our [sandbox](https://sec-api.io/sandbox).\n\n### Examples\n\nThe following example retrieves all 10-Q filings filed by TSLA in 2020.\n\n```python\nfrom sec_api import QueryApi\n\nqueryApi = QueryApi(api_key=\"YOUR_API_KEY\")\n\nquery = {\n  \"query\": \"ticker:TSLA AND filedAt:[2020-01-01 TO 2020-12-31] AND formType:\\\"10-Q\\\"\",\n  \"from\": \"0\",\n  \"size\": \"10\",\n  \"sort\": [{ \"filedAt\": { \"order\": \"desc\" } }]\n}\n\nfilings = queryApi.get_filings(query)\n\nprint(filings)\n```\n\nFind the most recently reported Form 8-K filings that include Item 9.01 \"Financial Statements and Exhibits\".\n\n```python\nquery = {\n  \"query\": \"formType:\\\"8-K\\\" AND items:\\\"9.01\\\"\",\n  \"from\": \"0\",\n  \"size\": \"10\",\n  \"sort\": [{ \"filedAt\": { \"order\": \"desc\" } }]\n}\n\nfilings = queryApi.get_filings(query)\n```\n\n> See the documentation for more details: https://sec-api.io/docs/query-api\n\n## Full-Text Search API\n\nFull-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.\n\n---\n\nThe 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\".\n\n```python\nfrom sec_api import FullTextSearchApi\n\nfullTextSearchApi = FullTextSearchApi(api_key=\"YOUR_API_KEY\")\n\nquery = {\n  \"query\": '\"LPCN 1154\"',\n  \"formTypes\": ['8-K', '10-Q'],\n  \"startDate\": '2021-01-01',\n  \"endDate\": '2021-06-14',\n}\n\nfilings = fullTextSearchApi.get_filings(query)\n\nprint(filings)\n```\n\n> See the documentation for more details: https://sec-api.io/docs/full-text-search-api\n\n## Filing Render & Download API\n\nUsed to download any filing or exhibit. You can process the downloaded filing in memory or save the filing to your hard drive.\n\n```python\nfrom sec_api import RenderApi\n\nrenderApi = RenderApi(api_key=\"YOUR_API_KEY\")\n\nurl = \"https://www.sec.gov/Archives/edgar/data/1662684/000110465921082303/tm2119986d1_8k.htm\"\n\nfiling = renderApi.get_filing(url)\n\nprint(filing)\n\n# for non-text data, such as a PDF files or an images,\n# use get_file() and set `return_binary=True` to get the binary data\npdf_file_url = \"https://www.sec.gov/Archives/edgar/data/1798925/999999999724004095/filename1.pdf\"\nbinary_data = renderApi.get_file(pdf_file_url, return_binary=True)\n\nwith open(\"filename.pdf\", \"wb\") as f:\n    f.write(binary_data)\n```\n\n> See the documentation for more details: https://sec-api.io/docs/sec-filings-render-api\n\n## PDF Generator API\n\nSEC filings, including Forms 10-K, 10-Q, 8-K, and others, are typically published in HTML, XML, or text formats. The PDF Generator API enables the conversion of any SEC filing or exhibit into a PDF file, preserving all original formatting, tables, images, and other elements from the filing.\n\n```python\nfrom sec_api import PdfGeneratorApi\n\npdfGeneratorApi = PdfGeneratorApi(\"YOUR_API_KEY\")\n\n# Form 8-K exhibit URL\nedgar_file_url = \"https://www.sec.gov/ix?doc=/Archives/edgar/data/1320695/000132069520000148/ths12-31x201910krecast.htm\"\n# Form 10-K filing URL\n# edgar_file_url = \"https://www.sec.gov/Archives/edgar/data/320193/000032019320000096/aapl-20200926.htm\"\n\npdf_file = pdfGeneratorApi.get_pdf(edgar_file_url)\n\nwith open(\"filename.pdf\", \"wb\") as f:\n    f.write(pdf_file)\n```\n\n> See the documentation for more details: https://sec-api.io/docs/sec-filings-render-api\n\n## SEC EDGAR Filings Real-Time Stream API\n\nThe Stream API provides a live stream (aka feed) of newly published filings on SEC EDGAR via WebSockets. A new filing is sent to your connected client as soon as it is published.\n\n---\n\nInstall the `websockets` client:\n\n```bash\npip install websockets\n```\n\nRun the example script below. Get your free API key on [sec-api.io](https://sec-api.io) and replace `YOUR_API_KEY` with it.\n\n```python\nimport asyncio\nimport websockets\nimport json\n\nAPI_KEY = \"YOUR_API_KEY\" # Replace this with your actual API key\nSERVER_URL = \"wss://stream.sec-api.io\"\nWS_ENDPOINT = SERVER_URL + \"?apiKey=\" + API_KEY\n\nasync def websocket_client():\n    try:\n        async with websockets.connect(WS_ENDPOINT) as websocket:\n            print(\"\u2705 Connected to:\", SERVER_URL)\n\n            while True:\n                message = await websocket.recv()\n                filings = json.loads(message)\n                for f in filings:\n                    print(f[\"accessionNo\"], f[\"formType\"], f[\"filedAt\"], f[\"cik\"])\n\n    except Exception as e:\n        print(f\"An unexpected error occurred: {e}\")\n\n\nasyncio.run(websocket_client())\n```\n\n> See the documentation for more details: https://sec-api.io/docs/stream-api\n\n## XBRL-To-JSON Converter API\n\nParse and standardize any XBRL and convert it to JSON or pandas dataframes. Extract financial statements and metadata from 10-K, 10-Q and any other SEC filing supporting XBRL.\n\nThe entire US GAAP taxonomy is fully supported. All XBRL items are fully converted into JSON, including `us-gaap`, `dei` and custom items. XBRL facts are automatically mapped to their respective context including period instants and date ranges.\n\nAll financial statements are accessible and standardized:\n\n- StatementsOfIncome\n- StatementsOfIncomeParenthetical\n- StatementsOfComprehensiveIncome\n- StatementsOfComprehensiveIncomeParenthetical\n- BalanceSheets\n- BalanceSheetsParenthetical\n- StatementsOfCashFlows\n- StatementsOfCashFlowsParenthetical\n- StatementsOfShareholdersEquity\n- StatementsOfShareholdersEquityParenthetical\n\nVariants such as `ConsolidatedStatementsofOperations` or `ConsolidatedStatementsOfLossIncome` are automatically standardized to their root name, e.g. `StatementsOfIncome`.\n\n### Income Statement - Example Item\n\n```json\n{\n  \"StatementsOfIncome\": {\n    \"RevenueFromContractWithCustomerExcludingAssessedTax\": [\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"startDate\": \"2019-09-29\",\n          \"endDate\": \"2020-09-26\"\n        },\n        \"value\": \"274515000000\"\n      },\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"startDate\": \"2018-09-30\",\n          \"endDate\": \"2019-09-28\"\n        },\n        \"value\": \"260174000000\"\n      }\n    ]\n  }\n}\n```\n\n### Usage\n\nThere are 3 ways to convert XBRL to JSON:\n\n- `htm_url`: Provide the URL of the filing ending with `.htm`.\n  Example URL: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm\n- `xbrl_url`: Provide the URL of the XBRL file ending with `.xml`. The XBRL file URL can be found in the `dataFiles` array returned by our query API. The array item has the description `EXTRACTED XBRL INSTANCE DOCUMENT` or similar.\n  Example URL: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml\n- `accession_no`: Provide the accession number of the filing, e.g. `0001564590-21-004599`\n\n```python\nfrom sec_api import XbrlApi\n\nxbrlApi = XbrlApi(\"YOUR_API_KEY\")\n\n# 10-K HTM File URL example\nxbrl_json = xbrlApi.xbrl_to_json(\n    htm_url=\"https://www.sec.gov/Archives/edgar/data/320193/000032019320000096/aapl-20200926.htm\"\n)\n\n# access income statement, balance sheet and cash flow statement\nprint(xbrl_json[\"StatementsOfIncome\"])\nprint(xbrl_json[\"BalanceSheets\"])\nprint(xbrl_json[\"StatementsOfCashFlows\"])\n\n# 10-K XBRL File URL example\nxbrl_json = xbrlApi.xbrl_to_json(\n    xbrl_url=\"https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml\"\n)\n\n# 10-K accession number example\nxbrl_json = xbrlApi.xbrl_to_json(accession_no=\"0001564590-21-004599\")\n```\n\n### Example Response\n\nNote: response is shortened.\n\n```json\n{\n  \"CoverPage\": {\n    \"DocumentPeriodEndDate\": \"2020-09-26\",\n    \"EntityRegistrantName\": \"Apple Inc.\",\n    \"EntityIncorporationStateCountryCode\": \"CA\",\n    \"EntityTaxIdentificationNumber\": \"94-2404110\",\n    \"EntityAddressAddressLine1\": \"One Apple Park Way\",\n    \"EntityAddressCityOrTown\": \"Cupertino\",\n    \"EntityAddressStateOrProvince\": \"CA\",\n    \"EntityAddressPostalZipCode\": \"95014\",\n    \"CityAreaCode\": \"408\",\n    \"LocalPhoneNumber\": \"996-1010\",\n    \"TradingSymbol\": \"AAPL\",\n    \"EntityPublicFloat\": {\n      \"decimals\": \"-6\",\n      \"unitRef\": \"usd\",\n      \"period\": {\n        \"instant\": \"2020-03-27\"\n      },\n      \"value\": \"1070633000000\"\n    },\n    \"EntityCommonStockSharesOutstanding\": {\n      \"decimals\": \"-3\",\n      \"unitRef\": \"shares\",\n      \"period\": {\n        \"instant\": \"2020-10-16\"\n      },\n      \"value\": \"17001802000\"\n    },\n    \"DocumentFiscalPeriodFocus\": \"FY\",\n    \"CurrentFiscalYearEndDate\": \"--09-26\"\n  },\n  \"StatementsOfIncome\": {\n    \"RevenueFromContractWithCustomerExcludingAssessedTax\": [\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"startDate\": \"2019-09-29\",\n          \"endDate\": \"2020-09-26\"\n        },\n        \"segment\": {\n          \"dimension\": \"srt:ProductOrServiceAxis\",\n          \"value\": \"us-gaap:ProductMember\"\n        },\n        \"value\": \"220747000000\"\n      },\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"startDate\": \"2018-09-30\",\n          \"endDate\": \"2019-09-28\"\n        },\n        \"segment\": {\n          \"dimension\": \"srt:ProductOrServiceAxis\",\n          \"value\": \"us-gaap:ProductMember\"\n        },\n        \"value\": \"213883000000\"\n      }\n    ]\n  },\n  \"BalanceSheets\": {\n    \"CashAndCashEquivalentsAtCarryingValue\": [\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"instant\": \"2020-09-26\"\n        },\n        \"value\": \"38016000000\"\n      },\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"instant\": \"2019-09-28\"\n        },\n        \"value\": \"48844000000\"\n      },\n      {\n        \"decimals\": \"-6\",\n        \"unitRef\": \"usd\",\n        \"period\": {\n          \"instant\": \"2020-09-26\"\n        },\n        \"segment\": {\n          \"dimension\": \"us-gaap:FinancialInstrumentAxis\",\n          \"value\": \"us-gaap:CashMember\"\n        },\n        \"value\": \"17773000000\"\n      }\n    ]\n  }\n}\n```\n\n> See the documentation for more details: https://sec-api.io/docs/xbrl-to-json-converter-api\n\n## 10-K/10-Q/8-K Section Extractor API\n\nThe 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.\n\n**All 10-K sections can be extracted:**\n\n- 1 - Business\n- 1A - Risk Factors\n- 1B - Unresolved Staff Comments\n- 1C - Cybersecurity (introduced in 2023)\n- 2 - Properties\n- 3 - Legal Proceedings\n- 4 - Mine Safety Disclosures\n- 5 - Market for Registrant\u2019s Common Equity, Related Stockholder Matters and Issuer Purchases of Equity Securities\n- 6 - Selected Financial Data (prior to February 2021)\n- 7 - Management\u2019s Discussion and Analysis of Financial Condition and Results of Operations\n- 7A - Quantitative and Qualitative Disclosures about Market Risk\n- 8 - Financial Statements and Supplementary Data\n- 9 - Changes in and Disagreements with Accountants on Accounting and Financial Disclosure\n- 9A - Controls and Procedures\n- 9B - Other Information\n- 10 - Directors, Executive Officers and Corporate Governance\n- 11 - Executive Compensation\n- 12 - Security Ownership of Certain Beneficial Owners and Management and Related Stockholder Matters\n- 13 - Certain Relationships and Related Transactions, and Director Independence\n- 14 - Principal Accountant Fees and Services\n\n**All 10-Q sections can be extracted:**\n\nPart 1:\n\n- 1 - Financial Statements\n- 2 - Management\u2019s Discussion and Analysis of Financial Condition and Results of Operations\n- 3 - Quantitative and Qualitative Disclosures About Market Risk\n- 4 - Controls and Procedures\n\nPart 2:\n\n- 1 - Legal Proceedings\n- 1A - Risk Factors\n- 2 -Unregistered Sales of Equity Securities and Use of Proceeds\n- 3 - Defaults Upon Senior Securities\n- 4 - Mine Safety Disclosures\n- 5 - Other Information\n- 6 - Exhibits\n\n**All 8-K sections can be extracted:**\n\n- 1.01: Entry into a Material Definitive Agreement\n- 1.02: Termination of a Material Definitive Agreement\n- 1.03: Bankruptcy or Receivership\n- 1.04: Mine Safety - Reporting of Shutdowns and Patterns of Violations\n- 1.05: Material Cybersecurity Incidents (introduced in 2023)\n- 2.01: Completion of Acquisition or Disposition of Assets\n- 2.02: Results of Operations and Financial Condition\n- 2.03: Creation of a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement of a Registrant\n- 2.04: Triggering Events That Accelerate or Increase a Direct Financial Obligation or an Obligation under an Off-Balance Sheet Arrangement\n- 2.05: Cost Associated with Exit or Disposal Activities\n- 2.06: Material Impairments\n- 3.01: Notice of Delisting or Failure to Satisfy a Continued Listing Rule or Standard; Transfer of Listing\n- 3.02: Unregistered Sales of Equity Securities\n- 3.03: Material Modifications to Rights of Security Holders\n- 4.01: Changes in Registrant's Certifying Accountant\n- 4.02: Non-Reliance on Previously Issued Financial Statements or a Related Audit Report or Completed Interim Review\n- 5.01: Changes in Control of Registrant\n- 5.02: Departure of Directors or Certain Officers; Election of Directors; Appointment of Certain Officers: Compensatory Arrangements of Certain Officers\n- 5.03: Amendments to Articles of Incorporation or Bylaws; Change in Fiscal Year\n- 5.04: Temporary Suspension of Trading Under Registrant's Employee Benefit Plans\n- 5.05: Amendments to the Registrant's Code of Ethics, or Waiver of a Provision of the Code of Ethics\n- 5.06: Change in Shell Company Status\n- 5.07: Submission of Matters to a Vote of Security Holders\n- 5.08: Shareholder Nominations Pursuant to Exchange Act Rule 14a-11\n- 6.01: ABS Informational and Computational Material\n- 6.02: Change of Servicer or Trustee\n- 6.03: Change in Credit Enhancement or Other External Support\n- 6.04: Failure to Make a Required Distribution\n- 6.05: Securities Act Updating Disclosure\n- 6.06: Static Pool\n- 6.10: Alternative Filings of Asset-Backed Issuers\n- 7.01: Regulation FD Disclosure\n- 8.01: Other Events\n- 9.01: Financial Statements and Exhibits\n- Signature\n\n### Usage\n\n```python\nfrom sec_api import ExtractorApi\n\nextractorApi = ExtractorApi(\"YOUR_API_KEY\")\n\n#\n# 10-K example\n#\n# Tesla 10-K filing\nfiling_url_10k = \"https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm\"\n\n# get the standardized and cleaned text of section 1A \"Risk Factors\"\nsection_text = extractorApi.get_section(filing_url_10k, \"1A\", \"text\")\n\n# get the original HTML of section 7 \"Management\u2019s Discussion and Analysis of Financial Condition and Results of Operations\"\nsection_html = extractorApi.get_section(filing_url_10k, \"7\", \"html\")\n\n#\n# 10-Q example\n#\n# Tesla 10-Q filing\nfiling_url_10q = \"https://www.sec.gov/Archives/edgar/data/1318605/000095017022006034/tsla-20220331.htm\"\n\n# extract section 1A \"Risk Factors\" in part 2 as cleaned text\nextracted_section_10q = extractorApi.get_section(filing_url_10q, \"part2item1a\", \"text\")\n\n#\n# 8-K example\n#\nfiling_url_8k = \"https://www.sec.gov/Archives/edgar/data/66600/000149315222016468/form8-k.htm\"\n\n# extract section 1.01 \"Entry into Material Definitive Agreement\" as cleaned text\nextracted_section_8k = extractorApi.get_section(filing_url_8k, \"1-1\", \"text\")\n```\n\n> See the documentation for more details: https://sec-api.io/docs/sec-filings-item-extraction-api\n\n## Form ADV API\n\nSearch the entire Form 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.\n\n```python\nfrom sec_api import FormAdvApi\n\nformAdvApi = FormAdvApi(\"YOUR_API_KEY\")\n\nresponse = formAdvApi.get_firms(\n    {\n        \"query\": \"Info.FirmCrdNb:361\",\n        \"from\": \"0\",\n        \"size\": \"10\",\n        \"sort\": [{\"Info.FirmCrdNb\": {\"order\": \"desc\"}}],\n    }\n)\nprint(response[\"filings\"])\n\ndirect_owners = formAdvApi.get_direct_owners(crd=\"793\")\nprint(direct_owners)\n\nindirect_owners = formAdvApi.get_indirect_owners(crd=\"326262\")\nprint(indirect_owners)\n\nprivate_funds = formAdvApi.get_private_funds(crd=\"793\")\nprint(private_funds)\n\nresponse = formAdvApi.get_individuals(\n    {\n        \"query\": \"CrntEmps.CrntEmp.orgPK:149777\",\n        \"from\": \"0\",\n        \"size\": \"10\",\n        \"sort\": [{\"id\": {\"order\": \"desc\"}}],\n    }\n)\nprint(response[\"filings\"])\n\nresponse = formAdvApi.get_brochures(149777)\nprint(response[\"brochures\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/investment-adviser-and-adv-api\n\n## Insider Trading Data API\n\nThe 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.\n\n```python\nfrom sec_api import InsiderTradingApi\n\ninsiderTradingApi = InsiderTradingApi(\"YOUR_API_KEY\")\n\ninsider_trades = insiderTradingApi.get_data({\n  \"query\": \"issuer.tradingSymbol:TSLA\"\n})\n\nprint(insider_trades[\"transactions\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/insider-ownership-trading-api\n\n### Response Example\n\n```json\n[\n  {\n    \"accessionNo\": \"0000899243-22-028189\",\n    \"filedAt\": \"2022-08-09T21:23:00-04:00\",\n    \"documentType\": \"4\",\n    \"periodOfReport\": \"2022-08-09\",\n    \"issuer\": {\n      \"cik\": \"1318605\",\n      \"name\": \"Tesla, Inc.\",\n      \"tradingSymbol\": \"TSLA\"\n    },\n    \"reportingOwner\": {\n      \"cik\": \"1494730\",\n      \"name\": \"Musk Elon\",\n      \"address\": {\n        \"street1\": \"C/O TESLA, INC.\",\n        \"street2\": \"1 TESLA ROAD\",\n        \"city\": \"AUSTIN\",\n        \"state\": \"TX\",\n        \"zipCode\": \"78725\"\n      },\n      \"relationship\": {\n        \"isDirector\": true,\n        \"isOfficer\": true,\n        \"officerTitle\": \"CEO\",\n        \"isTenPercentOwner\": true,\n        \"isOther\": false\n      }\n    },\n    \"nonDerivativeTable\": {\n      \"transactions\": [\n        {\n          \"securityTitle\": \"Common Stock\",\n          \"transactionDate\": \"2022-08-09\",\n          \"coding\": {\n            \"formType\": \"4\",\n            \"code\": \"S\",\n            \"equitySwapInvolved\": false\n          },\n          \"amounts\": {\n            \"shares\": 435,\n            \"pricePerShare\": 872.469,\n            \"pricePerShareFootnoteId\": [\"F1\"],\n            \"acquiredDisposedCode\": \"D\"\n          }\n        }\n      ]\n      // and many more\n    }\n  }\n]\n```\n\n## Form 13F Institutional Holdings Database\n\nFind the most recently disclosed Form 13F filings that include Tesla as a holding.\n\n```python\nfrom sec_api import QueryApi\n\nqueryApi = QueryApi(api_key=\"YOUR_API_KEY\")\n\nquery = {\n  \"query\": \"formType:\\\"13F\\\" AND holdings.ticker:TSLA\",\n  \"from\": \"0\",\n  \"size\": \"10\",\n  \"sort\": [{ \"filedAt\": { \"order\": \"desc\" } }]\n}\n\nfilings = queryApi.get_filings(query)\n```\n\n> See the documentation for more details: https://sec-api.io/docs/query-api/13f-institutional-ownership-api\n\n## Form 13D/13G API\n\nThe 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.\n\n```python\nfrom sec_api import Form13DGApi\n\nform13DGApi = Form13DGApi(\"YOUR_API_KEY\")\n\n# find the 50 most recently filed 13D/G filings disclosing 10% of more ownership of any Point72 company.\nquery = {\n    \"query\": \"owners.name:Point72 AND owners.amountAsPercent:[10 TO *]\",\n    \"from\": \"0\",\n    \"size\": \"50\",\n    \"sort\": [ { \"filedAt\": { \"order\": \"desc\"  } } ]\n}\n\nresponse = form13DGApi.get_data(query)\n\nprint(response[\"filings\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/form-13d-13g-search-api\n\n### Response Example\n\n```json\n{\n  \"total\": {\n    \"value\": 8,\n    \"relation\": \"eq\"\n  },\n  \"filings\": [\n    {\n      \"id\": \"bbb1ef1892bfc12a2e398c903871e3ae\",\n      \"accessionNo\": \"0000902664-22-005029\",\n      \"formType\": \"SC 13D\",\n      \"filedAt\": \"2022-12-05T16:00:20-05:00\",\n      \"filers\": [\n        {\n          \"cik\": \"1813658\",\n          \"name\": \"Tempo Automation Holdings, Inc. (Subject)\"\n        },\n        {\n          \"cik\": \"1954961\",\n          \"name\": \"Point72 Private Investments, LLC (Filed by)\"\n        }\n      ],\n      \"nameOfIssuer\": \"Tempo Automation Holdings, Inc.\",\n      \"titleOfSecurities\": \"Common Stock, par value $0.0001 per share\",\n      \"cusip\": [\"88024M108\"],\n      \"eventDate\": \"2022-11-22\",\n      \"schedule13GFiledPreviously\": false,\n      \"owners\": [\n        {\n          \"name\": \"Point72 Private Investments, LLC\",\n          \"memberOfGroup\": {\n            \"a\": false,\n            \"b\": false\n          },\n          \"sourceOfFunds\": [\"OO\"],\n          \"legalProceedingsDisclosureRequired\": false,\n          \"place\": \"Delaware\",\n          \"soleVotingPower\": 0,\n          \"sharedVotingPower\": 5351000,\n          \"soleDispositivePower\": 0,\n          \"sharedDispositivePower\": 5351000,\n          \"aggregateAmountOwned\": 5351000,\n          \"amountExcludesCertainShares\": false,\n          \"amountAsPercent\": 20.3,\n          \"typeOfReportingPerson\": [\"OO\"]\n        }\n      ]\n    }\n  ]\n}\n```\n\n## Form N-PORT API\n\nAccess and find standardized N-PORT SEC filings.\n\n```python\nfrom sec_api import FormNportApi\n\nnportApi = FormNportApi(\"YOUR_API_KEY\")\n\nresponse = nportApi.get_data(\n    {\n        \"query\": \"fundInfo.totAssets:[100000000 TO *]\",\n        \"from\": \"0\",\n        \"size\": \"10\",\n        \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n    }\n)\n\nprint(response[\"filings\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/n-port-data-api\n\n## Form S-1/424B4 API\n\nAccess and find structured and standardized data extracted from S-1, F-1, and S-11 registration statements as well as 424B4 prospectus filings. The JSON data includes public offering prices, underwriting discounts, proceeds before expenses, security types being offered, underwriters (lead and co-managers), law firms, auditors, employee counts and management information (name, age, position).\n\n```python\nfrom sec_api import Form_S1_424B4_Api\n\nform_s1_424B4_api = Form_S1_424B4_Api(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"ticker:V\",\n    \"from\": \"0\",\n    \"size\": \"50\",\n    \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n}\n\nresponse = form_s1_424B4_api.get_data(query)\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/form-s1-424b4-data-search-api\n\n## Form D API\n\nSearch 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.\n\n```python\nfrom sec_api import FormDApi\n\nformDApi = FormDApi(\"YOUR_API_KEY\")\n\nresponse = formDApi.get_data(\n    {\n        \"query\": \"offeringData.offeringSalesAmounts.totalOfferingAmount:[1000000 TO *]\",\n        \"from\": \"0\",\n        \"size\": \"10\",\n        \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n    }\n)\n\nprint(response[\"offerings\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/form-d-xml-json-api\n\n## Financial Restatements & Non-Reliance on Prior Financial Results (Item 4.02)\n\nAccess and search all financial restatements and non-reliance on prior financial results filings from 2004 to present. The database includes information about the CIK, ticker and company name the restatement is associated with, the publication date of the restatement, list of identified issues, affected reporting periods that require restatement, affected financial statement items, auditor involvement, and more.\n\n```python\nfrom sec_api import Item_4_02_Api\n\nitem_4_02_api = Item_4_02_Api(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"ticker:*\",\n    \"from\": \"0\",\n    \"size\": \"50\",\n    \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n}\n\nresponse = item_4_02_api.get_data(query)\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/form-8k-data-search-api\n\n## Directors & Board Members Data API\n\nAccess and search the entire database of all directors and board members of all publicly listed companies on US stock exchanges. The database includes information about the CIK, ticker and company name the director is associated with, the name of the director, her/his age, position, director class, date of first election, independence status, committee memberships as well as qualifications and experiences.\n\n```python\nfrom sec_api import DirectorsBoardMembersApi\n\ndirectorsBoardMembersApi = DirectorsBoardMembersApi(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"ticker:AMZN\",\n    \"from\": 0,\n    \"size\": 50,\n    \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n}\n\nresponse = directorsBoardMembersApi.get_data(query)\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/directors-and-board-members-data-api\n\n## Executive Compensation Data API\n\nThe API provides standardized compensation data of all key executives as reported in SEC filing DEF 14A. The dataset is updated in real-time.\n\nYou can search compensation data by 13 parameters, such as company ticker, executive name & position, annual salary, option awards and more.\n\n```python\nfrom sec_api import ExecCompApi\n\nexecCompApi = ExecCompApi(\"YOUR_API_KEY\")\n\n# Get data by ticker\nresult_ticker = execCompApi.get_data(\"TSLA\")\n\n# Get data by CIK\nresult_cik = execCompApi.get_data(\"789019\")\n\n# List all exec compensations of CIK 70858 for year 2020 and 2019\n# Sort result by year first, by name second\nquery = {\n    \"query\": \"cik:70858 AND (year:2020 OR year:2019)\",\n    \"from\": \"0\",\n    \"size\": \"200\",\n    \"sort\": [{\"year\": {\"order\": \"desc\"}}, {\"name.keyword\": {\"order\": \"asc\"}}],\n}\nresult_query = execCompApi.get_data(query)\n```\n\n### Response Example\n\n```json\n[\n  {\n    \"id\": \"8e9177e3bcdb30ada8d092c195bd9d63\",\n    \"cik\": \"1318605\",\n    \"ticker\": \"TSLA\",\n    \"name\": \"Andrew Baglino\",\n    \"position\": \"SVP, Powertrain and Energy Engineering\",\n    \"year\": 2020,\n    \"salary\": 283269,\n    \"bonus\": 0,\n    \"stockAwards\": 0,\n    \"optionAwards\": 46261354,\n    \"nonEquityIncentiveCompensation\": 0,\n    \"changeInPensionValueAndDeferredEarnings\": 0,\n    \"otherCompensation\": 0,\n    \"total\": 46544623\n  }\n  // and many more\n]\n```\n\n> See the documentation for more details: https://sec-api.io/docs/executive-compensation-api\n\n## Outstanding Shares & Public Float API\n\nThe Float API returns the number of outstanding shares and public float of any publicly traded company listed on US exchanges. The dataset includes the most recently reported number of outstanding shares and float as well as historical data. If a company registered multiple share classes, the API returns the number of shares outstanding of each class.\n\n```python\nfrom sec_api import FloatApi\n\nfloatApi = FloatApi(\"YOUR_API_KEY\")\n\nresponse = floatApi.get_float(ticker=\"GOOGL\")\nprint(response[\"data\"])\n\nresponse = floatApi.get_float(cik=\"1318605\")\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/outstanding-shares-float-api\n\n### Response Example | Float API\n\n```json\n{\n  \"data\": [\n    {\n      \"tickers\": [\"GOOGL\", \"GOOG\"],\n      \"cik\": \"1652044\",\n      \"reportedAt\": \"2023-02-02T21:23:45-05:00\",\n      \"periodOfReport\": \"2022-12-31\",\n      \"float\": {\n        \"outstandingShares\": [\n          {\n            \"period\": \"2023-01-26\",\n            \"shareClass\": \"CommonClassA\",\n            \"value\": 5956000000\n          },\n          {\n            \"period\": \"2023-01-26\",\n            \"shareClass\": \"CommonClassB\",\n            \"value\": 883000000\n          },\n          {\n            \"period\": \"2023-01-26\",\n            \"shareClass\": \"CapitalClassC\",\n            \"value\": 5968000000\n          }\n        ],\n        \"publicFloat\": [\n          {\n            \"period\": \"2022-06-30\",\n            \"shareClass\": \"\",\n            \"value\": 1256100000000\n          }\n        ]\n      },\n      \"sourceFilingAccessionNo\": \"0001652044-23-000016\",\n      \"id\": \"4a29432e1345e30a01e4aa10a2b57b62\"\n    }\n    // and more...\n  ]\n}\n```\n\n## Subsidiary API\n\n```python\nfrom sec_api import SubsidiaryApi\n\nsubsidiaryApi = SubsidiaryApi(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"ticker:TSLA\",\n    \"from\": \"0\",\n    \"size\": \"50\",\n    \"sort\": [{\"filedAt\": {\"order\": \"desc\"}}],\n}\n\nresponse = subsidiaryApi.get_data(query)\n\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/subsidiary-api\n\n### Response Example | Subsidiary API\n\n```json\n{\n  \"data\": [\n    {\n      \"id\": \"6838a63b29128e116bde65c885282667\",\n      \"accessionNo\": \"0000950170-23-001409\",\n      \"filedAt\": \"2023-01-30T21:29:15-05:00\",\n      \"cik\": \"1318605\",\n      \"ticker\": \"TSLA\",\n      \"companyName\": \"Tesla, Inc.\",\n      \"subsidiaries\": [\n        {\n          \"name\": \"Alabama Service LLC\",\n          \"jurisdiction\": \"Delaware\"\n        }\n        {\n          \"name\": \"Alset Warehouse GmbH\",\n          \"jurisdiction\": \"Germany\"\n        },\n        {\n          \"name\": \"BT Connolly Storage, LLC\",\n          \"jurisdiction\": \"Texas\"\n        },\n        {\n          \"name\": \"Fotovoltaica GI 4, S. de R.L. de C.V.\",\n          \"jurisdiction\": \"Mexico\"\n        },\n        // ... more subsidiaries\n      ]\n    },\n    // ... more historical lists of subsidiaries\n  ]\n}\n```\n\n## AAER Database API\n\nAccess and search the Accounting and Auditing Enforcement Releases (AAER) database. The database includes all AAERs filed from 1997 to present.\n\n```python\nfrom sec_api import AaerApi\n\naaerApi = AaerApi(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"dateTime:[2012-01-01 TO 2020-12-31]\",\n    \"from\": \"0\",\n    \"size\": \"50\",\n    \"sort\": [{\"dateTime\": {\"order\": \"desc\"}}],\n}\n\nresponse = aaerApi.get_data(query)\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/aaer-database-api\n\n## SRO Filings Database API\n\nAccess and search all SRO filings published from 1995 to present. The database includes more than 30,000 SRO filings from all types of organizations, including National Securities Exchanges (NYSE, NASDAQ, CBOE, etc.), Joint Industry Plans, FINRA, Futures Exchanges (CME, CBOT, etc.), and more.\n\n```python\nfrom sec_api import SroFilingsApi\n\nsroFilingsApi = SroFilingsApi(\"YOUR_API_KEY\")\n\nquery = {\n    \"query\": \"sro:NASDAQ\",\n    \"from\": \"0\",\n    \"size\": \"10\",\n    \"sort\": [{\"issueDate\": {\"order\": \"desc\"}}],\n}\n\nresponse = sroFilingsApi.get_data(query)\nprint(response[\"data\"])\n```\n\n> See the documentation for more details: https://sec-api.io/docs/sro-filings-database-api\n\n## CUSIP/CIK/Ticker Mapping API\n\nResolve 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.\n\nMap any of the following parameters to company details:\n\n- CUSIP\n- CIK\n- Ticker\n- Company name\n- Exchange\n- Sector\n- Industry\n\nThe function returns an array of all matching companies in JSON format. For example, a look up of the ticker `IBM` returns multiple matches including `IBMD` and `IBME`.\n\nA company object includes the following properties:\n\n- `name` (string) - the name of the company, e.g. Tesla Inc\n- `ticker` (string) - the ticker symbol of the company.\n- `cik` (string) - the CIK of the company. Trailing zeros are removed.\n- `cusip` (string) - one or multiple CUSIPs linked to the company. Multiple CUSIPs are delimited by space, e.g. \"054748108 92931L302 92931L401\"\n- `exchange` (string) - the main exchange the company is listed on, e.g. NASDAQ\n- `isDelisted` (boolean) - true if the company is no longer listed, false otherwise.\n- `category` (string) - the security category, e.g. \"Domestic Common Stock\"\n- `sector` (string) - the sector of the company, e.g. \"Consumer Cyclical\"\n- `industry` (string) - the industry of the company, e.g. \"Auto Manufacturers\"\n- `sic` (string) - four-digit SIC code, e.g. \"3711\"\n- `sicSector` (string) - SIC sector name of the company, e.g. \"Manufacturing\"\n- `sicIndustry` (string) - SIC industry name of the company, e.g. \"Motor Vehicles & Passenger Car Bodies\"\n- `currency` (string) - operating currency of the company, e.g. \"USD\"\n- `location` (string) - location of the company's headquarters\n- `id` (string) - unique internal ID of the company, e.g. \"e27d6e9606f216c569e46abf407685f3\"\n\nResponse type: `JSON`\n\n### Usage\n\n```python\nfrom sec_api import MappingApi\n\nmappingApi = MappingApi(api_key=\"YOUR_API_KEY\")\n\nresult1 = mappingApi.resolve(\"ticker\", \"TSLA\")\nresult2 = mappingApi.resolve(\"cik\", \"1318605\")\nresult3 = mappingApi.resolve(\"cusip\", \"88160R101\")\nresult4 = mappingApi.resolve(\"exchange\", \"NASDAQ\")\n```\n\n#### Response Example\n\n```json\n[\n  {\n    \"name\": \"Tesla Inc\",\n    \"ticker\": \"TSLA\",\n    \"cik\": \"1318605\",\n    \"cusip\": \"88160R101\",\n    \"exchange\": \"NASDAQ\",\n    \"isDelisted\": false,\n    \"category\": \"Domestic Common Stock\",\n    \"sector\": \"Consumer Cyclical\",\n    \"industry\": \"Auto Manufacturers\",\n    \"sic\": \"3711\",\n    \"sicSector\": \"Manufacturing\",\n    \"sicIndustry\": \"Motor Vehicles & Passenger Car Bodies\",\n    \"famaSector\": \"\",\n    \"famaIndustry\": \"Automobiles and Trucks\",\n    \"currency\": \"USD\",\n    \"location\": \"California; U.S.A\",\n    \"id\": \"e27d6e9606f216c569e46abf407685f3\"\n  }\n]\n```\n\n> See the documentation for more details: https://sec-api.io/docs/mapping-api\n\n## Proxy Support\n\nIn 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.\n\n```python\nfrom sec_api import QueryApi, RenderApi, ...\n\nproxies = {\n  \"http\": \"http://your-proxy.com\",\n  \"https\": \"https://your-proxy.com\",\n}\n\nqueryApi = QueryApi(api_key=\"YOUR_API_KEY\", proxies=proxies)\nrenderApi = RenderApi(api_key=\"YOUR_API_KEY\", proxies=proxies)\n```\n\n## Query API Response Format\n\n- `accessionNo` (string) - Accession number of filing, e.g. 0000028917-20-000033\n- `cik` (string) - CIK of the filing issuer. Important: trailing `0` are removed.\n- `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).\n- `companyName` (string) - Name of company, e.g. Allied Motion Technologies Inc\n- `companyNameLong` (string) - Long version of company name including the filer type (Issuer, Filer, Reporting), e.g. ALLIED MOTION TECHNOLOGIES INC (0000046129) (Issuer)\n- `formType` (string) - sec.gov form type, e.g 10-K. [See the list of supported form types here.](https://sec-api.io/#list-of-sec-form-types)\n- `description` (string) - Description of the form, e.g. Statement of changes in beneficial ownership of securities\n- `linkToFilingDetails` (string) - Link to HTML, XML or PDF version of the filing.\n- `linkToTxt` (string) - Link to the plain text version of the filing. This file can be multiple MBs large.\n- `linkToHtml` (string) - Link to index page of the filing listing all exhibits and the original HTML file.\n- `linkToXbrl` (string, optional) - Link to XBRL version of the filing (if available).\n- `filedAt` (string) - The date (format: YYYY-MM-DD HH:mm:SS TZ) the filing was filed, eg 2019-12-06T14:41:26-05:00.\n- `periodOfReport` (string, if reported) - Period of report, e.g. 2021-06-08\n- `effectivenessDate` (string, if reported) - Effectiveness date, e.g. 2021-06-08\n- `registrationForm` (string, if reported) - Registration form as reported on EFFECT forms, e.g. S-1\n- `referenceAccessionNo` (string, if reported) - Reference accession number as reported on EFFECT forms, e.g. 0001213900-22-001446\n- `items` (array of strings, if reported) - Items represents an array of item strings as reported on form 8-K, 8-K/A, D, D/A, ABS-15G, ABS-15G/A, 1-U, 1-U/A. For example: `[\"Item 3.02: Unregistered Sales of Equity Securities\", \"Item 9.01: Financial Statements and Exhibits\"]`\n- `groupMembers` (array, if reported) - Group members represents an array of member strings as reported on SC 13G, SC 13G/A, SC 13D, SC 13D/A filings, e.g. `[ \"ALEC N. LITOWITZMAGNETAR CAPITAL PARTNERS LPSUPERNOVA MANAGEMENT LLC\" ]`\n- `id` (string) - Unique ID of the filing.\n- `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:\n  - `companyName` (string) - Company name of the entity, e.g. DILLARD'S, INC. (Issuer)\n  - `cik` (string) - CIK of the entity. Trailing 0 are not removed here, e.g. 0000028917\n  - `irsNo` (string, optional) - IRS number of the entity, e.g. 710388071\n  - `stateOfIncorporation` (string, optional) - State of incorporation of entity, e.g. AR\n  - `fiscalYearEnd` (string, optional) - Fiscal year end of the entity, e.g. 0201\n  - `sic` (string, optional) - SIC of the entity, e.g. 5311 Retail-Department Stores\n  - `type` (string, optional) - Type of the filing being filed. Same as formType, e.g. 4\n  - `act` (string, optional) - The SEC act pursuant to which the filing was filed, e.g. 34\n  - `fileNo` (string, optional) - Filer number of the entity, e.g. 001-06140\n  - `filmNo` (string, optional) - Film number of the entity, e.g. 20575664\n- `documentFormatFiles` (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:\n  - `sequence` (string, optional) - The sequence number of the filing, e.g. 1\n  - `description` (string, optional) - Description of the file, e.g. EXHIBIT 31.1\n  - `documentUrl` (string) - URL to the file on SEC.gov\n  - `type` (string, optional) - Type of the file, e.g. EX-32.1, GRAPHIC or 10-Q\n  - `size` (string, optional) - Size of the file, e.g. 6627216\n- `dataFiles` (array) - List of data files (filing attachments, exhibits, XBRL files) attached to the filing.\n  - `sequence` (string) - Sequence number of the file, e.g. 6\n  - `description` (string) - Description of the file, e.g. XBRL INSTANCE DOCUMENT\n  - `documentUrl` (string) - URL to the file on SEC.gov\n  - `type` (string, optional) - Type of the file, e.g. EX-101.INS, EX-101.DEF or EX-101.PRE\n  - `size` (string, optional) - Size of the file, e.g. 6627216\n- `seriesAndClassesContractsInformation` (array) - List of series and classes/contracts information\n  - `series` (string) - Series ID, e.g. S000001297\n  - `name` (string) - Name of entity, e.g. PRUDENTIAL ANNUITIES LIFE ASSUR CORP VAR ACCT B CL 1 SUB ACCTS\n  - `classesContracts` (array) - List of classes/contracts. Each list item has the following keys:\n    - `classContract` (string) - Class/Contract ID, e.g. C000011787\n    - `name` (string) - Name of class/contract entity, e.g. Class L\n    - `ticker` (string) - Ticker class/contract entity, e.g. URTLX\n\n### 13F Institutional Ownerships\n\n13F filings report institutional ownerships. Each 13F filing has an attribute `holdings` (array). An array item in holdings represents one holding and has the following attributes:\n\n- `nameOfIssuer` (string) - Name of issuer, e.g. MICRON TECHNOLOGY INC\n- `titleOfClass` (string) - Title of class, e.g. COM\n- `cusip` (string) - CUSIP of security, e.g. 98850P109\n- `value` (integer) - Absolute holding value in $, e.g. 18000. Note: `value` doesn't have to be multiplied by 1000 anymore. It's done by our API automatically.\n- `shrsOrPrnAmt` (object)\n  - `sshPrnamt` (integer) - Shares or PRN AMT, e.g. 345\n  - `sshPrnamtType` (string) - Share/PRN type, e.g. \"SH\"\n- `putCall` (string, optional) - Put / Call, e.g. Put\n- `investmentDiscretion` (string) - Investment discretion, e.g. \"SOLE\"\n- `otherManager` (string, optional) - Other manager, e.g. 7\n- `votingAuthority` (object)\n  - `Sole` (integer) - Sole, e.g. 345\n  - `Shared` (integer) - Shared, e.g. 345\n  - `None` (integer) - None, e.g. 345\n\n### Query API Example JSON Response\n\n```json\n{\n  \"id\": \"79ad9e452ea42402df4fe55c636191d6\",\n  \"accessionNo\": \"0001213900-21-032169\",\n  \"cik\": \"1824149\",\n  \"ticker\": \"JOFF\",\n  \"companyName\": \"JOFF Fintech Acquisition Corp.\",\n  \"companyNameLong\": \"JOFF Fintech Acquisition Corp. (Filer)\",\n  \"formType\": \"10-Q\",\n  \"description\": \"Form 10-Q - Quarterly report [Sections 13 or 15(d)]\",\n  \"filedAt\": \"2021-06-11T17:25:44-04:00\",\n  \"linkToTxt\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169.txt\",\n  \"linkToHtml\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169-index.htm\",\n  \"linkToXbrl\": \"\",\n  \"linkToFilingDetails\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321_jofffintech.htm\",\n  \"entities\": [\n    {\n      \"companyName\": \"JOFF Fintech Acquisition Corp. (Filer)\",\n      \"cik\": \"1824149\",\n      \"irsNo\": \"852863893\",\n      \"stateOfIncorporation\": \"DE\",\n      \"fiscalYearEnd\": \"1231\",\n      \"type\": \"10-Q\",\n      \"act\": \"34\",\n      \"fileNo\": \"001-40005\",\n      \"filmNo\": \"211012398\",\n      \"sic\": \"6770 Blank Checks\"\n    }\n  ],\n  \"documentFormatFiles\": [\n    {\n      \"sequence\": \"1\",\n      \"description\": \"QUARTERLY REPORT\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321_jofffintech.htm\",\n      \"type\": \"10-Q\",\n      \"size\": \"274745\"\n    },\n    {\n      \"sequence\": \"2\",\n      \"description\": \"CERTIFICATION\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex31-1_jofffintech.htm\",\n      \"type\": \"EX-31.1\",\n      \"size\": \"12209\"\n    },\n    {\n      \"sequence\": \"3\",\n      \"description\": \"CERTIFICATION\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex31-2_jofffintech.htm\",\n      \"type\": \"EX-31.2\",\n      \"size\": \"12220\"\n    },\n    {\n      \"sequence\": \"4\",\n      \"description\": \"CERTIFICATION\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex32-1_jofffintech.htm\",\n      \"type\": \"EX-32.1\",\n      \"size\": \"4603\"\n    },\n    {\n      \"sequence\": \"5\",\n      \"description\": \"CERTIFICATION\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/f10q0321ex32-2_jofffintech.htm\",\n      \"type\": \"EX-32.2\",\n      \"size\": \"4607\"\n    },\n    {\n      \"sequence\": \"\u00a0\",\n      \"description\": \"Complete submission text file\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/0001213900-21-032169.txt\",\n      \"type\": \"\u00a0\",\n      \"size\": \"2344339\"\n    }\n  ],\n  \"dataFiles\": [\n    {\n      \"sequence\": \"6\",\n      \"description\": \"XBRL INSTANCE FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331.xml\",\n      \"type\": \"EX-101.INS\",\n      \"size\": \"248137\"\n    },\n    {\n      \"sequence\": \"7\",\n      \"description\": \"XBRL SCHEMA FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331.xsd\",\n      \"type\": \"EX-101.SCH\",\n      \"size\": \"43550\"\n    },\n    {\n      \"sequence\": \"8\",\n      \"description\": \"XBRL CALCULATION FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_cal.xml\",\n      \"type\": \"EX-101.CAL\",\n      \"size\": \"21259\"\n    },\n    {\n      \"sequence\": \"9\",\n      \"description\": \"XBRL DEFINITION FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_def.xml\",\n      \"type\": \"EX-101.DEF\",\n      \"size\": \"182722\"\n    },\n    {\n      \"sequence\": \"10\",\n      \"description\": \"XBRL LABEL FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_lab.xml\",\n      \"type\": \"EX-101.LAB\",\n      \"size\": \"309660\"\n    },\n    {\n      \"sequence\": \"11\",\n      \"description\": \"XBRL PRESENTATION FILE\",\n      \"documentUrl\": \"https://www.sec.gov/Archives/edgar/data/1824149/000121390021032169/joff-20210331_pre.xml\",\n      \"type\": \"EX-101.PRE\",\n      \"size\": \"186873\"\n    }\n  ],\n  \"seriesAndClassesContractsInformation\": [],\n  \"periodOfReport\": \"2021-03-31\",\n  \"effectivenessDate\": \"2021-03-31\"\n}\n```\n\n## Contact\n\nLet us know how we can improve the library or if you have any feature suggestions. We're happy to implement them.\n\nsupport@sec-api.io\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "SEC EDGAR Filings API",
    "version": "1.0.25",
    "project_urls": {
        "Bug Reports": "https://github.com/janlukasschroeder/sec-api-python/issues",
        "Documentation": "https://sec-api.io/docs",
        "Repository": "https://github.com/janlukasschroeder/sec-api-python"
    },
    "split_keywords": [
        "sec edgar api",
        " sec filings api",
        " sec filing search api",
        " sec full-text search api",
        " edgar api",
        " finance",
        " cik",
        " cusip",
        " cusip to ticker",
        " cusip to cik",
        " 10-q",
        " 10-k",
        " 8-k",
        " s-1",
        " 424b4",
        " xbrl converter",
        " financial statements api",
        " insider trading data",
        " executive compensation data",
        " form d offerings api",
        " form n-port api",
        " form adv api",
        " 10-k/10-q/8-k section extractor api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e59f3a44fdb1eb03105de1b435b7b5ec8fe28ea9167e1c61e32e96d959a5156",
                "md5": "73fcba77ea05c8e788f39adf52c2bc67",
                "sha256": "75482460c90492dd4fd46d584c56e33bd61cdef61ce3209e51611f8106f24537"
            },
            "downloads": -1,
            "filename": "sec_api-1.0.25-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73fcba77ea05c8e788f39adf52c2bc67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19999,
            "upload_time": "2024-10-16T15:05:31",
            "upload_time_iso_8601": "2024-10-16T15:05:31.009091Z",
            "url": "https://files.pythonhosted.org/packages/2e/59/f3a44fdb1eb03105de1b435b7b5ec8fe28ea9167e1c61e32e96d959a5156/sec_api-1.0.25-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e08a618a12b604fa6e3142683e48478404deed7e77c8088c8ad5b1264475e05",
                "md5": "105d5e57d161a67aecea4fcf8681b219",
                "sha256": "52a50a1ce54ded1dfd7d384dc9a2671bf36d505b820d53a13a27e3365270e1e2"
            },
            "downloads": -1,
            "filename": "sec-api-1.0.25.tar.gz",
            "has_sig": false,
            "md5_digest": "105d5e57d161a67aecea4fcf8681b219",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 48705,
            "upload_time": "2024-10-16T15:05:32",
            "upload_time_iso_8601": "2024-10-16T15:05:32.873247Z",
            "url": "https://files.pythonhosted.org/packages/5e/08/a618a12b604fa6e3142683e48478404deed7e77c8088c8ad5b1264475e05/sec-api-1.0.25.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 15:05:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "janlukasschroeder",
    "github_project": "sec-api-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sec-api"
}