Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 4.38 KB

File metadata and controls

108 lines (73 loc) · 4.38 KB

IEXCLOUD

2.0.17 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

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

Data Provider Rate Limits

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

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string crypto, eod-close, eod, price, stock stock

Crypto Endpoint

Supported names for this endpoint are: crypto, price.

Input Params

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

Example

Request:

{
  "data": {
    "endpoint": "crypto",
    "base": "ETH",
    "quote": "USD"
  }
}

Stock Endpoint

stock is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
base asset, coin, from, symbol, ticker The stock ticker to query string

Example

Request:

{
  "data": {
    "endpoint": "stock",
    "base": "USD"
  }
}

Eod Endpoint

Supported names for this endpoint are: eod, eod-close.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
base asset, coin, from, symbol, ticker The stock ticker to query string

Example

Request:

{
  "data": {
    "endpoint": "eod",
    "base": "USD"
  }
}

MIT License