Skip to content

Commit fc660fa

Browse files
actions-botactions-bot
committed
Auto-generate SDK for FinFeedAPI SEC API REST Historical
1 parent 118a4ec commit fc660fa

File tree

99 files changed

+446
-183
lines changed

Some content is hidden

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

99 files changed

+446
-183
lines changed

‎finfeedapi/sec-api-rest/sdk/ada/src/client/-clients.adb‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ package body .Clients is
112112
procedure V_1Filings_Get
113113
(Client : in out Client_Type;
114114
Cik : in Swagger.Nullable_Long;
115+
Ticker : in Swagger.Nullable_UString;
115116
Form_Type : in Swagger.Nullable_UString;
116117
Filling_Date_Start : in Swagger.Nullable_UString;
117118
Filling_Date_End : in Swagger.Nullable_UString;
@@ -130,6 +131,7 @@ package body .Clients is
130131

131132

132133
URI.Add_Param ("cik", Cik);
134+
URI.Add_Param ("ticker", Ticker);
133135
URI.Add_Param ("form_type", Form_Type);
134136
URI.Add_Param ("filling_date_start", Filling_Date_Start);
135137
URI.Add_Param ("filling_date_end", Filling_Date_End);

‎finfeedapi/sec-api-rest/sdk/ada/src/client/-clients.ads‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ package .Clients is
8585
procedure V_1Filings_Get
8686
(Client : in out Client_Type;
8787
Cik : in Swagger.Nullable_Long;
88+
Ticker : in Swagger.Nullable_UString;
8889
Form_Type : in Swagger.Nullable_UString;
8990
Filling_Date_Start : in Swagger.Nullable_UString;
9091
Filling_Date_End : in Swagger.Nullable_UString;

‎finfeedapi/sec-api-rest/sdk/android/docs/FilingMetadataApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010

1111
## v1FilingsGet
1212

13-
> List<DTOFilingMetadataDto> v1FilingsGet(cik, formType, fillingDateStart, fillingDateEnd, reportDateStart, reportDateEnd, itemsContain, pageSize, pageNumber, sortBy, sortOrder)
13+
> List<DTOFilingMetadataDto> v1FilingsGet(cik, ticker, formType, fillingDateStart, fillingDateEnd, reportDateStart, reportDateEnd, itemsContain, pageSize, pageNumber, sortBy, sortOrder)
1414
1515
Query SEC filing metadata
1616

@@ -24,6 +24,7 @@ Retrieves metadata for SEC filings based on various filter criteria with paginat
2424

2525
FilingMetadataApi apiInstance = new FilingMetadataApi();
2626
Long cik = null; // Long | Filter by Central Index Key (CIK)
27+
String ticker = null; // String | Filter by stock ticker symbol
2728
String formType = null; // String | Filter by form type(s) (e.g., \"10-K\", \"8-K\"). Multiple values can be comma-separated
2829
String fillingDateStart = null; // String | Filter by filling date start (inclusive), format YYYY-MM-DD
2930
String fillingDateEnd = null; // String | Filter by filling date end (inclusive), format YYYY-MM-DD
@@ -35,7 +36,7 @@ Integer pageNumber = null; // Integer | Page number to retrieve (default: 1)
3536
DTOFilingSortBy sortBy = null; // DTOFilingSortBy | Field to sort results by (default: AccessionNumber)
3637
String sortOrder = desc; // String | Sort order (asc or desc, default: desc)
3738
try {
38-
List<DTOFilingMetadataDto> result = apiInstance.v1FilingsGet(cik, formType, fillingDateStart, fillingDateEnd, reportDateStart, reportDateEnd, itemsContain, pageSize, pageNumber, sortBy, sortOrder);
39+
List<DTOFilingMetadataDto> result = apiInstance.v1FilingsGet(cik, ticker, formType, fillingDateStart, fillingDateEnd, reportDateStart, reportDateEnd, itemsContain, pageSize, pageNumber, sortBy, sortOrder);
3940
System.out.println(result);
4041
} catch (ApiException e) {
4142
System.err.println("Exception when calling FilingMetadataApi#v1FilingsGet");
@@ -49,6 +50,7 @@ try {
4950
Name | Type | Description | Notes
5051
------------- | ------------- | ------------- | -------------
5152
**cik** | **Long**| Filter by Central Index Key (CIK) | [optional] [default to null]
53+
**ticker** | **String**| Filter by stock ticker symbol | [optional] [default to null]
5254
**formType** | **String**| Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated | [optional] [default to null]
5355
**fillingDateStart** | **String**| Filter by filling date start (inclusive), format YYYY-MM-DD | [optional] [default to null]
5456
**fillingDateEnd** | **String**| Filter by filling date end (inclusive), format YYYY-MM-DD | [optional] [default to null]

‎finfeedapi/sec-api-rest/sdk/android/src/main/java/org/openapitools/client/api/FilingMetadataApi.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ public String getBasePath() {
6363
* Query SEC filing metadata
6464
* Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support. ### Available Sort Fields Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document ### Date Format All dates must be provided in YYYY-MM-DD format ### Form Types Form types can be provided as comma-separated values, e.g.: \&quot;10-K,8-K,10-Q\&quot; :::tip For optimal performance, use date ranges and form types to narrow down your search :::
6565
* @param cik Filter by Central Index Key (CIK)
66+
* @param ticker Filter by stock ticker symbol
6667
* @param formType Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated
6768
* @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD
6869
* @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD
@@ -75,7 +76,7 @@ public String getBasePath() {
7576
* @param sortOrder Sort order (asc or desc, default: desc)
7677
* @return List<DTOFilingMetadataDto>
7778
*/
78-
public List<DTOFilingMetadataDto> v1FilingsGet (Long cik, String formType, String fillingDateStart, String fillingDateEnd, String reportDateStart, String reportDateEnd, String itemsContain, Integer pageSize, Integer pageNumber, DTOFilingSortBy sortBy, String sortOrder) throws TimeoutException, ExecutionException, InterruptedException, ApiException {
79+
public List<DTOFilingMetadataDto> v1FilingsGet (Long cik, String ticker, String formType, String fillingDateStart, String fillingDateEnd, String reportDateStart, String reportDateEnd, String itemsContain, Integer pageSize, Integer pageNumber, DTOFilingSortBy sortBy, String sortOrder) throws TimeoutException, ExecutionException, InterruptedException, ApiException {
7980
Object postBody = null;
8081

8182
// create path and map variables
@@ -88,6 +89,7 @@ public List<DTOFilingMetadataDto> v1FilingsGet (Long cik, String formType, Strin
8889
// form params
8990
Map<String, String> formParams = new HashMap<String, String>();
9091
queryParams.addAll(ApiInvoker.parameterToPairs("", "cik", cik));
92+
queryParams.addAll(ApiInvoker.parameterToPairs("", "ticker", ticker));
9193
queryParams.addAll(ApiInvoker.parameterToPairs("", "form_type", formType));
9294
queryParams.addAll(ApiInvoker.parameterToPairs("", "filling_date_start", fillingDateStart));
9395
queryParams.addAll(ApiInvoker.parameterToPairs("", "filling_date_end", fillingDateEnd));
@@ -140,9 +142,9 @@ public List<DTOFilingMetadataDto> v1FilingsGet (Long cik, String formType, Strin
140142
/**
141143
* Query SEC filing metadata
142144
* Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support. ### Available Sort Fields Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document ### Date Format All dates must be provided in YYYY-MM-DD format ### Form Types Form types can be provided as comma-separated values, e.g.: \&quot;10-K,8-K,10-Q\&quot; :::tip For optimal performance, use date ranges and form types to narrow down your search :::
143-
* @param cik Filter by Central Index Key (CIK) * @param formType Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated * @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD * @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD * @param reportDateStart Filter by report date start (inclusive), format YYYY-MM-DD * @param reportDateEnd Filter by report date end (inclusive), format YYYY-MM-DD * @param itemsContain Filter filings where the &#39;Items&#39; field contains the specified text * @param pageSize Number of results per page (default: 50, max: 200) * @param pageNumber Page number to retrieve (default: 1) * @param sortBy Field to sort results by (default: AccessionNumber) * @param sortOrder Sort order (asc or desc, default: desc)
145+
* @param cik Filter by Central Index Key (CIK) * @param ticker Filter by stock ticker symbol * @param formType Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated * @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD * @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD * @param reportDateStart Filter by report date start (inclusive), format YYYY-MM-DD * @param reportDateEnd Filter by report date end (inclusive), format YYYY-MM-DD * @param itemsContain Filter filings where the &#39;Items&#39; field contains the specified text * @param pageSize Number of results per page (default: 50, max: 200) * @param pageNumber Page number to retrieve (default: 1) * @param sortBy Field to sort results by (default: AccessionNumber) * @param sortOrder Sort order (asc or desc, default: desc)
144146
*/
145-
public void v1FilingsGet (Long cik, String formType, String fillingDateStart, String fillingDateEnd, String reportDateStart, String reportDateEnd, String itemsContain, Integer pageSize, Integer pageNumber, DTOFilingSortBy sortBy, String sortOrder, final Response.Listener<List<DTOFilingMetadataDto>> responseListener, final Response.ErrorListener errorListener) {
147+
public void v1FilingsGet (Long cik, String ticker, String formType, String fillingDateStart, String fillingDateEnd, String reportDateStart, String reportDateEnd, String itemsContain, Integer pageSize, Integer pageNumber, DTOFilingSortBy sortBy, String sortOrder, final Response.Listener<List<DTOFilingMetadataDto>> responseListener, final Response.ErrorListener errorListener) {
146148
Object postBody = null;
147149

148150

@@ -157,6 +159,7 @@ public void v1FilingsGet (Long cik, String formType, String fillingDateStart, St
157159
Map<String, String> formParams = new HashMap<String, String>();
158160

159161
queryParams.addAll(ApiInvoker.parameterToPairs("", "cik", cik));
162+
queryParams.addAll(ApiInvoker.parameterToPairs("", "ticker", ticker));
160163
queryParams.addAll(ApiInvoker.parameterToPairs("", "form_type", formType));
161164
queryParams.addAll(ApiInvoker.parameterToPairs("", "filling_date_start", fillingDateStart));
162165
queryParams.addAll(ApiInvoker.parameterToPairs("", "filling_date_end", fillingDateEnd));

‎finfeedapi/sec-api-rest/sdk/apex/force-app/main/default/classes/OASFilingMetadataApi.cls‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ public class OASFilingMetadataApi {
2929
* Query SEC filing metadata
3030
* Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.\r\n\r\n### Available Sort Fields\r\n\r\nField Name | Description\r\n-----------|-------------\r\nAccessionNumber | SEC filing accession number\r\nFilingDate | Date when filing was submitted\r\nAcceptanceDateTime | Date and time of filing acceptance\r\nReportDate | Date of the report\r\nSize | Size of the filing document\r\n\r\n### Date Format\r\nAll dates must be provided in YYYY-MM-DD format\r\n\r\n### Form Types\r\nForm types can be provided as comma-separated values, e.g.: &quot;10-K,8-K,10-Q&quot;\r\n\r\n:::tip\r\nFor optimal performance, use date ranges and form types to narrow down your search\r\n:::
3131
* @param cik Filter by Central Index Key (CIK) (optional)
32+
* @param ticker Filter by stock ticker symbol (optional)
3233
* @param formType Filter by form type(s) (e.g., &quot;10-K&quot;, &quot;8-K&quot;). Multiple values can be comma-separated (optional)
3334
* @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD (optional)
3435
* @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD (optional)
@@ -47,6 +48,7 @@ public class OASFilingMetadataApi {
4748

4849
// cast query params to verify their expected type
4950
query.addAll(client.makeParam('cik', (Long) params.get('cik')));
51+
query.addAll(client.makeParam('ticker', (String) params.get('ticker')));
5052
query.addAll(client.makeParam('form_type', (String) params.get('formType')));
5153
query.addAll(client.makeParam('filling_date_start', (String) params.get('fillingDateStart')));
5254
query.addAll(client.makeParam('filling_date_end', (String) params.get('fillingDateEnd')));

‎finfeedapi/sec-api-rest/sdk/apex/force-app/main/default/classes/OASFilingMetadataApiTest.cls‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ private class OASFilingMetadataApiTest {
1414

1515
Map<String, Object> params = new Map<String, Object>{
1616
'cik' => 2147483648L,
17+
'ticker' => 'null',
1718
'formType' => 'null',
1819
'fillingDateStart' => 'null',
1920
'fillingDateEnd' => 'null',

‎finfeedapi/sec-api-rest/sdk/bash/_client.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,7 @@ case $state in
327327
local -a _op_arguments
328328
_op_arguments=(
329329
"cik=:[QUERY] Filter by Central Index Key (CIK)"
330+
"ticker=:[QUERY] Filter by stock ticker symbol"
330331
"form_type=:[QUERY] Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated"
331332
"filling_date_start=:[QUERY] Filter by filling date start (inclusive), format YYYY-MM-DD"
332333
"filling_date_end=:[QUERY] Filter by filling date end (inclusive), format YYYY-MM-DD"

‎finfeedapi/sec-api-rest/sdk/bash/client.sh‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ operation_parameters_minimum_occurrences["v1ExtractorItemGet:::accession_number"
102102
operation_parameters_minimum_occurrences["v1ExtractorItemGet:::item_number"]=1
103103
operation_parameters_minimum_occurrences["v1ExtractorItemGet:::type"]=0
104104
operation_parameters_minimum_occurrences["v1FilingsGet:::cik"]=0
105+
operation_parameters_minimum_occurrences["v1FilingsGet:::ticker"]=0
105106
operation_parameters_minimum_occurrences["v1FilingsGet:::form_type"]=0
106107
operation_parameters_minimum_occurrences["v1FilingsGet:::filling_date_start"]=0
107108
operation_parameters_minimum_occurrences["v1FilingsGet:::filling_date_end"]=0
@@ -138,6 +139,7 @@ operation_parameters_maximum_occurrences["v1ExtractorItemGet:::accession_number"
138139
operation_parameters_maximum_occurrences["v1ExtractorItemGet:::item_number"]=0
139140
operation_parameters_maximum_occurrences["v1ExtractorItemGet:::type"]=0
140141
operation_parameters_maximum_occurrences["v1FilingsGet:::cik"]=0
142+
operation_parameters_maximum_occurrences["v1FilingsGet:::ticker"]=0
141143
operation_parameters_maximum_occurrences["v1FilingsGet:::form_type"]=0
142144
operation_parameters_maximum_occurrences["v1FilingsGet:::filling_date_start"]=0
143145
operation_parameters_maximum_occurrences["v1FilingsGet:::filling_date_end"]=0
@@ -171,6 +173,7 @@ operation_parameters_collection_type["v1ExtractorItemGet:::accession_number"]=""
171173
operation_parameters_collection_type["v1ExtractorItemGet:::item_number"]=""
172174
operation_parameters_collection_type["v1ExtractorItemGet:::type"]=""
173175
operation_parameters_collection_type["v1FilingsGet:::cik"]=""
176+
operation_parameters_collection_type["v1FilingsGet:::ticker"]=""
174177
operation_parameters_collection_type["v1FilingsGet:::form_type"]=""
175178
operation_parameters_collection_type["v1FilingsGet:::filling_date_start"]=""
176179
operation_parameters_collection_type["v1FilingsGet:::filling_date_end"]=""
@@ -793,6 +796,8 @@ For optimal performance, use date ranges and form types to narrow down your sear
793796
echo -e "${BOLD}${WHITE}Parameters${OFF}"
794797
echo -e " * ${GREEN}cik${OFF} ${BLUE}[integer]${OFF} ${CYAN}(default: null)${OFF} - Filter by Central Index Key (CIK)${YELLOW} Specify as: cik=value${OFF}" \
795798
| paste -sd' ' | fold -sw 80 | sed '2,$s/^/ /'
799+
echo -e " * ${GREEN}ticker${OFF} ${BLUE}[string]${OFF} ${CYAN}(default: null)${OFF} - Filter by stock ticker symbol${YELLOW} Specify as: ticker=value${OFF}" \
800+
| paste -sd' ' | fold -sw 80 | sed '2,$s/^/ /'
796801
echo -e " * ${GREEN}form_type${OFF} ${BLUE}[string]${OFF} ${CYAN}(default: null)${OFF} - Filter by form type(s) (e.g., \"10-K\", \"8-K\"). Multiple values can be comma-separated${YELLOW} Specify as: form_type=value${OFF}" \
797802
| paste -sd' ' | fold -sw 80 | sed '2,$s/^/ /'
798803
echo -e " * ${GREEN}filling_date_start${OFF} ${BLUE}[string]${OFF} ${CYAN}(default: null)${OFF} - Filter by filling date start (inclusive), format YYYY-MM-DD${YELLOW} Specify as: filling_date_start=value${OFF}" \
@@ -1063,7 +1068,7 @@ call_v1FilingsGet() {
10631068
local path_parameter_names=()
10641069
# ignore error about 'query_parameter_names' being unused; passed by reference
10651070
# shellcheck disable=SC2034
1066-
local query_parameter_names=(cik form_type filling_date_start filling_date_end report_date_start report_date_end items_contain page_size page_number sort_by sort_order)
1071+
local query_parameter_names=(cik ticker form_type filling_date_start filling_date_end report_date_start report_date_end items_contain page_size page_number sort_by sort_order)
10671072
local path
10681073

10691074
if ! path=$(build_request_path "/v1/filings" path_parameter_names query_parameter_names); then

‎finfeedapi/sec-api-rest/sdk/bash/client.sh.bash-completion‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ _()
8080
declare -A operation_parameters
8181
operation_parameters["v1ExtractorGet"]="accession_number= type= "
8282
operation_parameters["v1ExtractorItemGet"]="accession_number= item_number= type= "
83-
operation_parameters["v1FilingsGet"]="cik= form_type= filling_date_start= filling_date_end= report_date_start= report_date_end= items_contain= page_size= page_number= sort_by= sort_order= "
83+
operation_parameters["v1FilingsGet"]="cik= ticker= form_type= filling_date_start= filling_date_end= report_date_start= report_date_end= items_contain= page_size= page_number= sort_by= sort_order= "
8484
operation_parameters["v1FullTextGet"]="form_type= filling_date_start= filling_date_end= text_contains= text_not_contain= page_size= page_number= sort_by= sort_order= "
8585
operation_parameters["v1XbrlConverterGet"]="htm-url= xbrl-url= accession-no= "
8686

‎finfeedapi/sec-api-rest/sdk/bash/docs/FilingMetadataApi.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For optimal performance, use date ranges and form types to narrow down your sear
3737
### Example
3838

3939
```bash
40-
v1FilingsGet cik=value form_type=value filling_date_start=value filling_date_end=value report_date_start=value report_date_end=value items_contain=value page_size=value page_number=value sort_by=value sort_order=value
40+
v1FilingsGet cik=value ticker=value form_type=value filling_date_start=value filling_date_end=value report_date_start=value report_date_end=value items_contain=value page_size=value page_number=value sort_by=value sort_order=value
4141
```
4242

4343
### Parameters
@@ -46,6 +46,7 @@ For optimal performance, use date ranges and form types to narrow down your sear
4646
Name | Type | Description | Notes
4747
------------- | ------------- | ------------- | -------------
4848
**cik** | **integer** | Filter by Central Index Key (CIK) | [optional] [default to null]
49+
**ticker** | **string** | Filter by stock ticker symbol | [optional] [default to null]
4950
**formType** | **string** | Filter by form type(s) (e.g., \"10-K\", \"8-K\"). Multiple values can be comma-separated | [optional] [default to null]
5051
**fillingDateStart** | **string** | Filter by filling date start (inclusive), format YYYY-MM-DD | [optional] [default to null]
5152
**fillingDateEnd** | **string** | Filter by filling date end (inclusive), format YYYY-MM-DD | [optional] [default to null]

0 commit comments

Comments
 (0)