Socket
Socket
Sign inDemoInstall

tradingview-ws

Package Overview
Dependencies
8
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

tradingview-ws

Tradingview websocket API


Version published
Maintainers
1
Weekly downloads
21
increased by200%

Weekly downloads

Readme

Source

Tradingview websockets integration

Unofficial library to interact with websockets on Tradingview.

Features

  • Realtime data from Tradingview
  • Authorization with session id from cookies
  • Fetching candlesticks for any symbol with any available timeframe

Example

import { connect, getCandles } from 'tradingview-ws'

(async function() {
  const connection = await connect()
  const candles = await getCandles({
    connection,
    symbols: ['FX:AUDCAD', 'FX:AUDCHF'],
    amount: 10_000,
    timeframe: 60
  })
  await connection.close()
  console.log(`Candles for AUDCAD:`, candles[0])
  console.log(`Candles for AUDCHF:`, candles[1])
}());

API

connect(options: ConnectionOptions = {}): Promise<TradingviewConnection>

Creates new connection to tradingview websockets. Returns TradingviewConnection.

Options:

  • sessionId?: string - authorize connection if present. Can be received from cookies.

getCandles({ connection, symbols, amount, timeframe = 60 }: GetCandlesParams)

Fetches all available candles for symbols. The maximum amount is around 13_000 candles for the hourly timeframe. Returns an array where each element is an array of candles for one symbol in the order it passed to the function.

Options:

  • connection: TradingviewConnection - connection object
  • symbols: string[] - array of symbols. Symbol name can be found on Symbol info modal(click three dots after symbol name on the top left corner of the chart).
  • timeframe?: number | '1D' | '1W' | '1M' - candlestick timeframe, default is 60
  • amount?: number - amount of candles to fetch. If not present, it will try to fetch as much as possible.

TradingviewConnection

Connection object. Can be used directly to receive and send data to websockets.

Methods:

  • subscribe: (handler: Subscriber) => Unsubscriber - subscribe to websockets events
  • send: (name: string, params: any[]) => void - send command to websockets
  • close: () => Promise<void> - close the connection

Keywords

FAQs

Last updated on 26 Mar 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc