@sfayman/stocktwits-cli

stocktwits-cli

Provides stock data by Stocktwits REST API

• Usage
• Commands

Usage

$ npm install -g @sfayman/stocktwits-cli
$ stocktwits-cli COMMAND
running command...
$ stocktwits-cli (-v|--version|version)
@sfayman/stocktwits-cli/0.0.4 darwin-x64 node-v13.12.0
$ stocktwits-cli --help [COMMAND]
USAGE
  $ stocktwits-cli COMMAND
...

Commands

• stocktwits-cli help [COMMAND]
• stocktwits-cli streams PRODUCT
• stocktwits-cli trending PRODUCT

stocktwits-cli help [COMMAND]

display help for stocktwits-cli

USAGE
  $ stocktwits-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stocktwits-cli streams PRODUCT

Returns the most recent messages for the specified product in the following format: message id, created at, message body, sentiment: Bullish, Bearish, Unknown

USAGE
  $ stocktwits-cli streams PRODUCT

ARGUMENTS
  PRODUCT  (suggested|symbol|trending|user) Supported products

OPTIONS
  -a, --data=data            [default: TSLA]

  -d, --delimiter=delimiter  [default:
                             ]

  -h, --help                 show CLI help

  -o, --output=output        append output to file

EXAMPLES
  $ stocktwits-cli streams symbol --data TSLA # Returns the most recent 30 messages for the specified symbol.
  $ stocktwits-cli streams user --data howardlindzon # Returns the most recent 30 messages for the specified user.
  $ stocktwits-cli streams suggested # Returns the most recent 30 messages from our suggested users, a curated list of 
  quality Stocktwits contributors.
  $ stocktwits-cli streams trending # Returns a list of  messages of the trending 30 equities at the moment requested.

See code: src/commands/streams.ts

stocktwits-cli trending PRODUCT

Returns a list of all the trending symbols or equities at the moment requested. These are updated in 5-minute intervals.

USAGE
  $ stocktwits-cli trending PRODUCT

ARGUMENTS
  PRODUCT  (symbols|equities) Symbols include equties and non-equities like futures and forex. Equities doesn't include
           futures and forex

OPTIONS
  -d, --delimiter=delimiter  [default: ,]
  -h, --help                 show CLI help
  -o, --output=output        append output to file

EXAMPLES
  $ stocktwits-cli trending symbols # Returns a list of all the trending symbols at the moment requested. Trending 
  symbols include equties and non-equities like futures and forex.
  stocktwits-cli trending symbols --output results.txt
  $ stocktwits-cli trending -d ';' symbols
  $ stocktwits-cli trending equities # Returns a list of all the trending equity symbols at the moment requested. 
  Trending equities have to have a price over $5.

See code: src/commands/trending.ts

• stocktwits-cli help [COMMAND]

stocktwits-cli streams PRODUCT

Returns the most recent messages for the specified product.

USAGE
  $ stocktwits-cli streams PRODUCT

ARGUMENTS
  PRODUCT  (symbol|trending) Supported products

OPTIONS
  -a, --data=data            [default: TSLA]

  -d, --delimiter=delimiter  [default: 
                             ]

  -h, --help                 show CLI help

  -o, --output=output        append output to file

EXAMPLES
  $ stocktwits-cli streams symbol --data 'TSLA'
  $ stocktwits-cli streams trending
  $ stocktwits-cli streams trending --output results.txt

stocktwits-cli trending PRODUCT

Returns a list of all the trending symbols at the moment requested. These are updated in 5-minute intervals.

USAGE
  $ stocktwits-cli trending PRODUCT

ARGUMENTS
  PRODUCT  (symbols|equities) Symbols include equties and non-equities like futures and forex. Equities doesn't include futures and forex

OPTIONS
  -d, --delimiter=delimiter  [default: ,]
  -h, --help                 show CLI help
  -o, --output=output        append output to file
EXAMPLE
  $ stocktwits-cli trending equities
  SAVA,CCXX,MFAC,OSH,CEO,ISEE,VALE,IQ,CNBKA,LCA,AERI,NNOX,BMY,CTRA,ORCL,AVDL,SNAP,MA,SOAC,WMT,HLT,SUPN,HSY,HAL,BMI,SGMO,BLNK,GRAF,CPE,MAT

stocktwits-cli help [COMMAND]

display help for stocktwits-cli

USAGE
  $ stocktwits-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI