Skip to content

Commit e7cb707

Browse files
ssnyder-intriniossnyder-intrinio
committed
No release notes for this build
1 parent 235e3b5 commit e7cb707

25 files changed

+543
-543
lines changed

‎docs/Company.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Name | Type | Description
4141
**industry_category** | **Character** | The company's operating industry category  
4242
**industry_group** | **Character** | The company's operating industry group  
4343
**template** | **Character** | The financial statement template used by Intrinio to standardize the as reported data  
44-
**standardized_active** | [**Logical**](Logical.md) | If true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as-reported data only  
44+
**standardized_active** | [**Logical**](Logical.md) | If TRUE, the company has standardized and as reported fundamental data via the Intrinio API; if FALSE, the company has as-reported data only  
4545
**first_fundamental_date** | [**Date**](Date.md) | The period end date of the company's first reported fundamental  
4646
**last_fundamental_date** | [**Date**](Date.md) | The period end date of the company's last reported fundamental  
4747
**first_stock_price_date** | [**Date**](Date.md) | The date of the company's first stock price, based on the company's primary security, which is typically traded on US exchages  

‎docs/CompanyApi.md

+87-87
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
8080

8181
# Optional params
8282
opts <- list(
83-
latest_filing_date = as.Date("\"~null\""),
84-
sic = "~null",
85-
template = "\"~null\"",
86-
sector = "~null",
87-
industry_category = "~null",
88-
industry_group = "~null",
89-
has_fundamentals = true,
90-
has_stock_prices = true,
91-
thea_enabled = "~null",
83+
latest_filing_date = NULL,
84+
sic = NULL,
85+
template = NULL,
86+
sector = NULL,
87+
industry_category = NULL,
88+
industry_group = NULL,
89+
has_fundamentals = TRUE,
90+
has_stock_prices = TRUE,
91+
thea_enabled = NULL,
9292
page_size = 100,
93-
next_page = "~null"
93+
next_page = NULL
9494
)
9595

9696
response <- CompanyApi$get_all_companies(opts)
@@ -116,8 +116,8 @@ Name | Type | Description | Notes
116116
**sector** | Character| Return companies in the given industry sector | [optional] &nbsp;
117117
**industry_category** | Character| Return companies in the given industry category | [optional] &nbsp;
118118
**industry_group** | Character| Return companies in the given industry group | [optional] &nbsp;
119-
**has_fundamentals** | Logical| Return only companies that have fundamentals when true | [optional] &nbsp;
120-
**has_stock_prices** | Logical| Return only companies that have stock prices when true | [optional] &nbsp;
119+
**has_fundamentals** | Logical| Return only companies that have fundamentals when TRUE | [optional] &nbsp;
120+
**has_stock_prices** | Logical| Return only companies that have stock prices when TRUE | [optional] &nbsp;
121121
**thea_enabled** | Logical| Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint | [optional] &nbsp;
122122
**page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
123123
**next_page** | Character| Gets the next page of data from a previous API call | [optional] &nbsp;
@@ -185,8 +185,8 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
185185
opts <- list(
186186
on_date = as.Date("2013-10-20"),
187187
page_size = 100,
188-
next_page = "~null",
189-
next_page2 = "~null"
188+
next_page = NULL,
189+
next_page2 = NULL
190190
)
191191

192192
response <- CompanyApi$get_all_companies_daily_metrics(opts)
@@ -272,21 +272,21 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
272272

273273
# Optional params
274274
opts <- list(
275-
specific_source = "\"~null\"",
275+
specific_source = NULL,
276276
page_size = 100,
277-
sentiment = "\"~null\"",
278-
topic = "~null",
277+
sentiment = NULL,
278+
topic = NULL,
279279
company = "AAPL",
280280
security = "AAPL",
281-
start_date = as.Date("\"~null\""),
282-
end_date = as.Date("\"~null\""),
283-
language = "~null",
284-
word_count_greater_than = "~null",
285-
word_count_less_than = "~null",
286-
is_spam = "~null",
287-
business_relevance_greater_than = "~null",
288-
business_relevance_less_than = "~null",
289-
next_page = "~null"
281+
start_date = NULL,
282+
end_date = NULL,
283+
language = NULL,
284+
word_count_greater_than = NULL,
285+
word_count_less_than = NULL,
286+
is_spam = NULL,
287+
business_relevance_greater_than = NULL,
288+
business_relevance_less_than = NULL,
289+
next_page = NULL
290290
)
291291

292292
response <- CompanyApi$get_all_company_news(opts)
@@ -552,8 +552,8 @@ identifier <- "AAPL"
552552
opts <- list(
553553
on_date = as.Date("2013-10-20"),
554554
page_size = 100,
555-
next_page = "~null",
556-
next_page2 = "~null"
555+
next_page = NULL,
556+
next_page2 = NULL
557557
)
558558

559559
response <- CompanyApi$get_company_daily_metrics(identifier, opts)
@@ -809,12 +809,12 @@ identifier <- "AAPL"
809809

810810
# Optional params
811811
opts <- list(
812-
report_type = "~null",
813-
start_date = as.Date("\"2015-01-01\""),
814-
end_date = as.Date("\"~null\""),
815-
thea_enabled = "~null",
812+
report_type = NULL,
813+
start_date = as.Date("2015-01-01"),
814+
end_date = NULL,
815+
thea_enabled = NULL,
816816
page_size = 100,
817-
next_page = "~null"
817+
next_page = NULL
818818
)
819819

820820
response <- CompanyApi$get_company_filings(identifier, opts)
@@ -906,18 +906,18 @@ identifier <- "AAPL"
906906

907907
# Optional params
908908
opts <- list(
909-
filed_after = as.Date("\"~null\""),
910-
filed_before = as.Date("\"~null\""),
911-
reported_only = false,
912-
fiscal_year = "~null",
913-
statement_code = "\"~null\"",
914-
type = "\"~null\"",
915-
start_date = as.Date("\"~null\""),
916-
end_date = as.Date("\"~null\""),
917-
updated_after = as.Date("\"2022-12-01\""),
918-
updated_before = as.Date("\"2022-12-01\""),
909+
filed_after = NULL,
910+
filed_before = NULL,
911+
reported_only = FALSE,
912+
fiscal_year = NULL,
913+
statement_code = NULL,
914+
type = NULL,
915+
start_date = NULL,
916+
end_date = NULL,
917+
updated_after = as.Date("2022-12-01"),
918+
updated_before = as.Date("2022-12-01"),
919919
page_size = 100,
920-
next_page = "~null"
920+
next_page = NULL
921921
)
922922

923923
response <- CompanyApi$get_company_fundamentals(identifier, opts)
@@ -1017,12 +1017,12 @@ tag <- "marketcap"
10171017
# Optional params
10181018
opts <- list(
10191019
frequency = "daily",
1020-
type = "\"~null\"",
1021-
start_date = as.Date("\"2018-01-01\""),
1022-
end_date = as.Date("\"~null\""),
1020+
type = NULL,
1021+
start_date = as.Date("2018-01-01"),
1022+
end_date = NULL,
10231023
sort_order = "desc",
10241024
page_size = 100,
1025-
next_page = "~null"
1025+
next_page = NULL
10261026
)
10271027

10281028
response <- CompanyApi$get_company_historical_data(identifier, tag, opts)
@@ -1114,13 +1114,13 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
11141114
# Optional params
11151115
opts <- list(
11161116
ticker = "UBER",
1117-
status = "\"~null\"",
1118-
start_date = as.Date("\"~null\""),
1119-
end_date = as.Date("\"~null\""),
1120-
offer_amount_greater_than = "~null",
1121-
offer_amount_less_than = "~null",
1117+
status = NULL,
1118+
start_date = NULL,
1119+
end_date = NULL,
1120+
offer_amount_greater_than = NULL,
1121+
offer_amount_less_than = NULL,
11221122
page_size = 100,
1123-
next_page = "~null"
1123+
next_page = NULL
11241124
)
11251125

11261126
response <- CompanyApi$get_company_ipos(opts)
@@ -1213,20 +1213,20 @@ identifier <- "AAPL"
12131213

12141214
# Optional params
12151215
opts <- list(
1216-
specific_source = "\"~null\"",
1216+
specific_source = NULL,
12171217
page_size = 100,
1218-
sentiment = "\"~null\"",
1219-
topic = "~null",
1218+
sentiment = NULL,
1219+
topic = NULL,
12201220
security = "AAPL",
1221-
start_date = as.Date("\"~null\""),
1222-
end_date = as.Date("\"~null\""),
1223-
language = "~null",
1224-
word_count_greater_than = "~null",
1225-
word_count_less_than = "~null",
1226-
is_spam = "~null",
1227-
business_relevance_greater_than = "~null",
1228-
business_relevance_less_than = "~null",
1229-
next_page = "~null"
1221+
start_date = NULL,
1222+
end_date = NULL,
1223+
language = NULL,
1224+
word_count_greater_than = NULL,
1225+
word_count_less_than = NULL,
1226+
is_spam = NULL,
1227+
business_relevance_greater_than = NULL,
1228+
business_relevance_less_than = NULL,
1229+
next_page = NULL
12301230
)
12311231

12321232
response <- CompanyApi$get_company_news(identifier, opts)
@@ -1323,12 +1323,12 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
13231323

13241324
# Required params
13251325
news_story_id <- "new_aBcDef"
1326-
publication_date <- as.POSIXlt("\"~null\"", tz="UTC")
1326+
publication_date <- as.POSIXlt(NULL, tz="UTC")
13271327

13281328
# Optional params
13291329
opts <- list(
1330-
specific_source = "\"~null\"",
1331-
next_page = "~null"
1330+
specific_source = NULL,
1331+
next_page = NULL
13321332
)
13331333

13341334
response <- CompanyApi$get_company_news_body(news_story_id, publication_date, opts)
@@ -1417,10 +1417,10 @@ identifier <- "AAPL"
14171417

14181418
# Optional params
14191419
opts <- list(
1420-
float_date_greater_than = as.Date("\"~null\""),
1421-
float_date_less_than = as.Date("\"~null\""),
1422-
next_page = "~null",
1423-
next_page2 = "~null"
1420+
float_date_greater_than = NULL,
1421+
float_date_less_than = NULL,
1422+
next_page = NULL,
1423+
next_page2 = NULL
14241424
)
14251425

14261426
response <- CompanyApi$get_company_public_float(identifier, opts)
@@ -1510,7 +1510,7 @@ identifier <- "AAPL"
15101510

15111511
# Optional params
15121512
opts <- list(
1513-
next_page = "~null"
1513+
next_page = NULL
15141514
)
15151515

15161516
response <- CompanyApi$get_company_securities(identifier, opts)
@@ -1597,13 +1597,13 @@ identifier <- "AAPL"
15971597

15981598
# Optional params
15991599
opts <- list(
1600-
start_date = as.Date("\"2018-01-01\""),
1601-
end_date = as.Date("\"2019-01-01\""),
1600+
start_date = as.Date("2018-01-01"),
1601+
end_date = as.Date("2019-01-01"),
16021602
ownership_type = "D",
1603-
next_page = "~null",
1603+
next_page = NULL,
16041604
page_size = 1000,
1605-
sort_by = "\"updated_on\"",
1606-
next_page2 = "~null"
1605+
sort_by = "updated_on",
1606+
next_page2 = NULL
16071607
)
16081608

16091609
response <- CompanyApi$insider_transaction_filings_by_company(identifier, opts)
@@ -1696,7 +1696,7 @@ identifier <- "AAPL"
16961696

16971697
# Optional params
16981698
opts <- list(
1699-
next_page = "~null"
1699+
next_page = NULL
17001700
)
17011701

17021702
response <- CompanyApi$latest_insider_transaction_filing_by_company(identifier, opts)
@@ -1780,8 +1780,8 @@ CompanyApi <- IntrinioSDK::CompanyApi$new(client)
17801780

17811781
# Required params
17821782
identifier <- "AAPL"
1783-
statement_code <- "\"income_statement\""
1784-
fiscal_period <- "\"FY\""
1783+
statement_code <- "income_statement"
1784+
fiscal_period <- "FY"
17851785
fiscal_year <- 2017
17861786

17871787
response <- CompanyApi$lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
@@ -1951,8 +1951,8 @@ query <- "Apple"
19511951

19521952
# Optional params
19531953
opts <- list(
1954-
active = true,
1955-
mode = "\"~null\"",
1954+
active = TRUE,
1955+
mode = NULL,
19561956
page_size = 100
19571957
)
19581958

@@ -1974,7 +1974,7 @@ print(response$content)
19741974
Name | Type | Description | Notes
19751975
------------- | ------------- | ------------- | -------------
19761976
**query** | Character| Search parameters | &nbsp;
1977-
**active** | Logical| When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional] &nbsp;
1977+
**active** | Logical| When TRUE, return companies that are actively traded (having stock prices within the past 14 days). When FALSE, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional] &nbsp;
19781978
**mode** | Character| When set, changes search mode to the specified mode. | [optional] &nbsp;
19791979
**page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
19801980
<br/>
@@ -2042,8 +2042,8 @@ identifier <- "AAPL"
20422042

20432043
# Optional params
20442044
opts <- list(
2045-
end_date_greater_than = as.Date("\"~null\""),
2046-
end_date_less_than = as.Date("\"~null\"")
2045+
end_date_greater_than = NULL,
2046+
end_date_less_than = NULL
20472047
)
20482048

20492049
response <- CompanyApi$shares_outstanding_by_company(identifier, opts)

‎docs/DataTagApi.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ DataTagApi <- IntrinioSDK::DataTagApi$new(client)
6161

6262
# Optional params
6363
opts <- list(
64-
tag = "~null",
65-
type = "~null",
66-
parent = "~null",
67-
statement_code = "\"income_statement\"",
64+
tag = NULL,
65+
type = NULL,
66+
parent = NULL,
67+
statement_code = "income_statement",
6868
fs_template = "industrial",
6969
page_size = 100,
70-
next_page = "~null"
70+
next_page = NULL
7171
)
7272

7373
response <- DataTagApi$get_all_data_tags(opts)

‎docs/ESGApi.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ opts <- list(
6666
industry = "Retail",
6767
ticker = "SHOP",
6868
page_size = 100,
69-
next_page = "~null"
69+
next_page = NULL
7070
)
7171

7272
response <- ESGApi$get_esg_companies(opts)
@@ -156,7 +156,7 @@ identifier <- "AAPL"
156156
# Optional params
157157
opts <- list(
158158
page_size = 100,
159-
next_page = "~null"
159+
next_page = NULL
160160
)
161161

162162
response <- ESGApi$get_esg_company_comprehensive_ratings(identifier, opts)
@@ -244,7 +244,7 @@ identifier <- "AAPL"
244244
# Optional params
245245
opts <- list(
246246
page_size = 100,
247-
next_page = "~null"
247+
next_page = NULL
248248
)
249249

250250
response <- ESGApi$get_esg_company_ratings(identifier, opts)
@@ -330,7 +330,7 @@ ESGApi <- IntrinioSDK::ESGApi$new(client)
330330
opts <- list(
331331
country = "USA",
332332
page_size = 100,
333-
next_page = "~null"
333+
next_page = NULL
334334
)
335335

336336
response <- ESGApi$get_esg_latest(opts)
@@ -416,7 +416,7 @@ ESGApi <- IntrinioSDK::ESGApi$new(client)
416416
opts <- list(
417417
country = "USA",
418418
page_size = 100,
419-
next_page = "~null"
419+
next_page = NULL
420420
)
421421

422422
response <- ESGApi$get_esg_latest_comprehensive(opts)

0 commit comments

Comments
 (0)