Intrinio

Usage:

intrinio get [--csv] PATH [PARAMS...]
intrinio pretty PATH [PARAMS...]
intrinio see PATH [PARAMS...]
intrinio url PATH [PARAMS...]
intrinio save [--csv] FILE PATH [PARAMS...]
intrinio (-h|--help|--version)

Commands:

get
  Downloads data and prints it to screen as it. 

pretty
  Downloads data and prints it as a prettified JSON output.

see
  Downloads data and awesome-prints it.

url
  Shows the URL constructed from the request.

save
  Downloads data and saves it to a file.

Parameters:

PATH:
  This is the Intrinio API path, without the query string.
  For example: `indices` or `historical_data`.

PARAMS:
  An optional list of query string parameters, separated by a space, to 
  send with the request. Each parameter should be in the format of 
  key:value, for example: page:2 per_page:10

FILE:
  Path to the output file.

Flags:

--csv
  When this flag is provided, the data will be converted to CSV before
  it is displayed or saved. Note that this works only with endpoints that
  have a 'data' attribute.

Environment Variables:

INTRINIO_AUTH=username:password
  Set Intrinio username and password. This variable is required.

INTRINIO_CACHE_LIFE=360
  Set the number of seconds to consider the cache fresh. This variable
  it optional.

INTRINIO_CACHE_DIR=./cache
  Set the cache directory. This variable is optional.
  If both INTRINIO_CACHE_DIR and INTRINIO_CACHE_LIFE are not set, requests
  will not be cached.

Examples:

intrinio see indices page_size:5

intrinio pretty indices "query:interest rate" page_size:5

intrinio see companies identifier:AAPL

intrinio see historical_data identifier:\$INTDSRUSM193N item:level \
  start_date:2015-01-01

intrinio see historical_data identifier:\$SP500 item:percent_change \
  frequency:monthly page_size:10

intrinio save aapl.json historical_data identifier:AAPL \
  item:adj_close_price frequency:monthly page_size:10

intrinio get --csv indices page_size:5

intrinio save --csv indices.csv indices page_size:5