This document was generated automatically. Please see README Generator for more info.
Required? | Name | Description | Type | Options | Default |
---|---|---|---|---|---|
API_ENDPOINT | API endpoint for iex-cloud | string | https://cloud.iexapis.com/stable |
||
✅ | API_KEY | An API key that can be obtained from here | string |
Name | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note |
---|---|---|---|---|
individual | 6944.44444444 | only mentions monthly limit | ||
business | 208333.333333 | only mentions monthly limit |
Required? | Name | Description | Type | Options | Default |
---|---|---|---|---|---|
endpoint | The endpoint to use | string | crypto, eod-close, eod, price, stock | stock |
Supported names for this endpoint are: crypto
, price
.
Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
---|---|---|---|---|---|---|---|---|
✅ | base | asset , coin , from , symbol |
The symbol of symbols of the currency to query | string | ||||
✅ | quote | market , to |
The symbol of the currency to convert to | string |
Request:
{
"data": {
"endpoint": "crypto",
"base": "ETH",
"quote": "USD"
}
}
stock
is the only supported name for this endpoint.
Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
---|---|---|---|---|---|---|---|---|
✅ | base | asset , coin , from , symbol , ticker |
The stock ticker to query | string |
Request:
{
"data": {
"endpoint": "stock",
"base": "USD"
}
}
Supported names for this endpoint are: eod
, eod-close
.
Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
---|---|---|---|---|---|---|---|---|
✅ | base | asset , coin , from , symbol , ticker |
The stock ticker to query | string |
Request:
{
"data": {
"endpoint": "eod",
"base": "USD"
}
}
MIT License