Expand description
Fundamental identifiers and wire-level value types.
Structs§
- ApiDate
Time - A timezone-less API datetime represented as exactly
YYYY-MM-DD HH:MM:SS. - Benchmark
Year - An open, representation-preserving executive-compensation benchmark query year.
- Bulk
Part - An open, representation-preserving provider bulk partition.
- Calendar
Quarter - A numeric calendar quarter received in a response.
- Calendar
Year - A numeric calendar year received in a response.
- Cik
- A Central Index Key.
- Congressional
Member Id - A representation-preserving congressional member identifier.
- Country
Code - An open provider country code.
- Currency
Code - An open provider currency code.
- Cusip
- A CUSIP identifier.
- Date
- A date represented on the wire as exactly
YYYY-MM-DD. - Date
Range - An inclusive date range whose start is not later than its end.
- Empty
Ticker List - Error returned when constructing an empty ticker list.
- Exchange
Code - An open provider exchange code.
- Finite
Decimal - A finite decimal suitable for inclusion in a request URL.
- Form
Type - An open, representation-preserving SEC filing form type.
- Industry
- An open provider company industry.
- Invalid
Calendar Quarter - Why a numeric response quarter was rejected.
- Invalid
Date Range - Error returned when an inclusive date range starts after it ends.
- Invalid
Temporal Value - Error returned when a date or API datetime does not match its wire format.
- Isin
- An ISIN identifier.
- Lei
- A Legal Entity Identifier.
- Limit
- A representation-preserving provider result limit.
- Market
Hours Timestamp - An opaque, representation-preserving market-hours query timestamp.
- NonFinite
Decimal - Error returned when a query decimal is NaN or infinite.
- Page
- A representation-preserving provider page index.
- Search
Term - A representation-preserving provider search term.
- Sector
- An open provider company sector.
- Ticker
- A provider ticker symbol.
- Ticker
List - A non-empty sequence of tickers encoded as a comma-separated query value.
- TipRanks
Expert Uid - A representation-preserving stable TipRanks analyst identifier.
- Transaction
Type Code - An open, representation-preserving insider transaction type code.
- Unix
Milliseconds - A Unix timestamp measured in milliseconds.
- Unix
Seconds - A Unix timestamp measured in seconds.
Enums§
- String
Value Error - Why a string-backed identifier or code was rejected.
Type Aliases§
- Change
- A signed change represented by the provider as a JSON number.
- Count
- A non-negative count represented by the provider as a JSON integer.
- Market
Capitalization - A market capitalization represented by the provider as a JSON number.
- Market
Value - A currency amount represented by the provider as a JSON number.
- PerShare
Amount - A per-share amount represented by the provider as a JSON number.
- Percentage
- A percentage represented by the provider as a JSON number.
- Price
- A price represented by the provider as a JSON number.
- Quantity
- A share or unit quantity represented by the provider as a JSON number.
- Ratio
- A dimensionless ratio represented by the provider as a JSON number.
- Split
Term - One term (numerator or denominator) of a stock-split ratio.
- Statement
Amount - A signed currency amount reported in a financial statement.
- Token
Supply - A cryptocurrency supply (coins or tokens) represented as a JSON number.
- Volume
- A traded volume represented by the provider as a JSON number.