IEXClientApi class
The IEX Cloud API is based on REST, has resource-oriented URLs, returns JSON-encoded responses, and returns standard HTTP response codes.
@reference https://iexcloud.io/docs/api/
@author tiarebalbi
@version v1.0.0
Constructors
- IEXClientApi({required String token, ApiVersion apiVersion = ApiVersion.stable, String baseUrl = 'https://cloud.iexapis.com', int connectTimeout = 5000, int sendTimeout = 3000, int receiveTimeout = 3000})
- Constructor
Properties
- apiVersion → ApiVersion
-
IEX API Version
final
- baseUrl → String
-
IEX Base URL
final
- connectTimeout → int
-
Connection Timeout to be used by the API requests
final
- dio → Dio
-
DIO Client instance used to send all requests
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
- receiveTimeout → int
-
Receive Timeout to be used by the API requests
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sendTimeout → int
-
Send Timeout to be used by the API requests
final
- token → String
-
IEX Cloud authenticates your API requests using your account’s API tokens.
To use any IEX Cloud API, you must pass an API token with each request.
If you do not include your API token when making an API request,
or use one that is incorrect or disabled, IEX Cloud returns an error.
final
Methods
-
addInterceptor(
Interceptor interceptor) → void - Add a new interceptor to be executed against all requests
-
clearInterceptors(
) → void - Remove all interceptors
-
cryptocurrencyBook(
String symbol) → Future< CryptoBook?> - Cryptocurrency Cryptocurrency Book
-
cryptocurrencyPrice(
String symbol) → Future< CryptoPrice?> - Cryptocurrency Price
-
cryptocurrencyQuote(
String symbol) → Future< CryptoQuote?> - Cryptocurrency Events NOT SUPPORT IN MVP VERSION (1.0.0), REST SUPPORT ONLY
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
status(
) → Future< Status?> - API System Metadata Status
-
symbols(
String? format) → Future< List< MarketSymbol> > - Symbols This refdata endpoint returns the list of symbols that IEX Cloud supports for intraday price updates.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited