Skip to content

Commit 14d9484

Browse files
committed
Auto-generate Python SDK for SEC API Historical
1 parent 1cd77bf commit 14d9484

File tree

97 files changed

+144
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+144
-166
lines changed

finfeedapi/sec-api/sdk/android/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ All URIs are relative to *https://api-historical.sec.finfeedapi.com*
8484

8585
Class | Method | HTTP request | Description
8686
------------ | ------------- | ------------- | -------------
87-
*ContentExtractionApi* | [**v1ExtractorGet**](docs/ContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
87+
*ContentExtractionApi* | [**v1ExtractorGet**](docs/ContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
8888
*ContentExtractionApi* | [**v1ExtractorItemGet**](docs/ContentExtractionApi.md#v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
8989
*FilingMetadataApi* | [**v1FilingsGet**](docs/FilingMetadataApi.md#v1FilingsGet) | **GET** /v1/filings | Query SEC filing metadata
9090
*FullTextSearchApi* | [**v1FullTextGet**](docs/FullTextSearchApi.md#v1FullTextGet) | **GET** /v1/full-text | Full-text search of SEC filing documents

finfeedapi/sec-api/sdk/android/docs/ContentExtractionApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All URIs are relative to *https://api-historical.sec.finfeedapi.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**v1ExtractorGet**](ContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
7+
[**v1ExtractorGet**](ContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
88
[**v1ExtractorItemGet**](ContentExtractionApi.md#v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
99

1010

@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313

1414
> DTOFilingExtractResultDto v1ExtractorGet(accessionNumber, type)
1515
16-
Extract and classify SEC filing content
16+
Extract and classify SEC filing content
1717

1818
Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
1919

finfeedapi/sec-api/sdk/android/src/main/java/org/openapitools/client/api/ContentExtractionApi.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public String getBasePath() {
5959
}
6060

6161
/**
62-
* Extract and classify SEC filing content
62+
* Extract and classify SEC filing content
6363
* Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
6464
* @param accessionNumber The SEC filing accession number used to retrieve the filing from EDGAR database.
6565
* @param type Result type (text or html, default: text)
@@ -124,7 +124,7 @@ public DTOFilingExtractResultDto v1ExtractorGet (String accessionNumber, DTOExtr
124124
}
125125

126126
/**
127-
* Extract and classify SEC filing content
127+
* Extract and classify SEC filing content
128128
* Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
129129
* @param accessionNumber The SEC filing accession number used to retrieve the filing from EDGAR database. * @param type Result type (text or html, default: text)
130130
*/

finfeedapi/sec-api/sdk/apex/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ All URIs are relative to *https://api-historical.sec.finfeedapi.com*
6464

6565
Class | Method | HTTP request | Description
6666
------------ | ------------- | ------------- | -------------
67-
*OASContentExtractionApi* | [**v1ExtractorGet**](OASContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
67+
*OASContentExtractionApi* | [**v1ExtractorGet**](OASContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
6868
*OASContentExtractionApi* | [**v1ExtractorItemGet**](OASContentExtractionApi.md#v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
6969
*OASFilingMetadataApi* | [**v1FilingsGet**](OASFilingMetadataApi.md#v1FilingsGet) | **GET** /v1/filings | Query SEC filing metadata
7070
*OASFullTextSearchApi* | [**v1FullTextGet**](OASFullTextSearchApi.md#v1FullTextGet) | **GET** /v1/full-text | Full-text search of SEC filing documents

finfeedapi/sec-api/sdk/apex/force-app/main/default/classes/OASContentExtractionApi.cls

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class OASContentExtractionApi {
2626
}
2727

2828
/**
29-
* Extract and classify SEC filing content
29+
* Extract and classify SEC filing content
3030
* Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.\r\n\r\n### Supported Form Types\r\n\r\nForm Type | Description\r\n----------|------------\r\n8-K | Current report filing\r\n10-K | Annual report filing\r\n10-Q | Quarterly report filing\r\n\r\n### Content Classification\r\n- 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)\r\n- 10-K/10-Q forms: Items categorized by their respective part and item structure\r\n\r\n:::note\r\nBoth HTML and plain text documents are supported for content extraction.\r\n:::
3131
* @param accessionNumber The SEC filing accession number used to retrieve the filing from EDGAR database. (required)
3232
* @param type Result type (text or html, default: text) (optional)

finfeedapi/sec-api/sdk/apex/force-app/main/default/classes/OASContentExtractionApiTest.cls

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
@isTest
22
private class OASContentExtractionApiTest {
33
/**
4-
* Extract and classify SEC filing content
4+
* Extract and classify SEC filing content
55
*
66
* Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.\r\n\r\n### Supported Form Types\r\n\r\nForm Type | Description\r\n----------|------------\r\n8-K | Current report filing\r\n10-K | Annual report filing\r\n10-Q | Quarterly report filing\r\n\r\n### Content Classification\r\n- 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)\r\n- 10-K/10-Q forms: Items categorized by their respective part and item structure\r\n\r\n:::note\r\nBoth HTML and plain text documents are supported for content extraction.\r\n:::
77
*/

finfeedapi/sec-api/sdk/c/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ All URIs are relative to *https://api-historical.sec.finfeedapi.com*
6666

6767
Category | Method | HTTP request | Description
6868
------------ | ------------- | ------------- | -------------
69-
*ContentExtractionAPI* | [**ContentExtractionAPI_v1ExtractorGet**](docs/ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
69+
*ContentExtractionAPI* | [**ContentExtractionAPI_v1ExtractorGet**](docs/ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
7070
*ContentExtractionAPI* | [**ContentExtractionAPI_v1ExtractorItemGet**](docs/ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
7171
*FilingMetadataAPI* | [**FilingMetadataAPI_v1FilingsGet**](docs/FilingMetadataAPI.md#FilingMetadataAPI_v1FilingsGet) | **GET** /v1/filings | Query SEC filing metadata
7272
*FullTextSearchAPI* | [**FullTextSearchAPI_v1FullTextGet**](docs/FullTextSearchAPI.md#FullTextSearchAPI_v1FullTextGet) | **GET** /v1/full-text | Full-text search of SEC filing documents

finfeedapi/sec-api/sdk/c/api/ContentExtractionAPI.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ static rest_api_v1ExtractorItemGet_type_e v1ExtractorItemGet__parseFromJSON(cJSO
9393
*/
9494

9595

96-
// Extract and classify SEC filing content
96+
// Extract and classify SEC filing content
9797
//
9898
// Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
9999
//

finfeedapi/sec-api/sdk/c/api/ContentExtractionAPI.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ typedef enum { rest_api_v1ExtractorGet__NULL = 0, rest_api_v1ExtractorGet__text
1717
typedef enum { rest_api_v1ExtractorItemGet__NULL = 0, rest_api_v1ExtractorItemGet__text, rest_api_v1ExtractorItemGet__html } rest_api_v1ExtractorItemGet_type_e;
1818

1919

20-
// Extract and classify SEC filing content
20+
// Extract and classify SEC filing content
2121
//
2222
// Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
2323
//

finfeedapi/sec-api/sdk/c/docs/ContentExtractionAPI.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ All URIs are relative to *https://api-historical.sec.finfeedapi.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**ContentExtractionAPI_v1ExtractorGet**](ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
7+
[**ContentExtractionAPI_v1ExtractorGet**](ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
88
[**ContentExtractionAPI_v1ExtractorItemGet**](ContentExtractionAPI.md#ContentExtractionAPI_v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
99

1010

1111
# **ContentExtractionAPI_v1ExtractorGet**
1212
```c
13-
// Extract and classify SEC filing content
13+
// Extract and classify SEC filing content
1414
//
1515
// Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories. ### Supported Form Types Form Type | Description ----------|------------ 8-K | Current report filing 10-K | Annual report filing 10-Q | Quarterly report filing ### Content Classification - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01) - 10-K/10-Q forms: Items categorized by their respective part and item structure :::note Both HTML and plain text documents are supported for content extraction. :::
1616
//

0 commit comments

Comments
 (0)