Skip to content

tradewatch-io/typescript-sdk

BranchesTags

Repository files navigation

TradeWatch.io TypeScript SDK

TradeWatch.io logo

Official SDK for the TradeWatch.io API.

Other SDKs

Python SDK .NET SDK PHP SDK Java SDK Go SDK Ruby SDK Swift SDK Rust SDK

What is TradeWatch.io?

TradeWatch.io is a market data platform and API for real-time and historical prices across crypto, stocks, indices, currencies, and commodities.

Try the Interactive API Playground

Want to test endpoints without writing code first? Use the TradeWatch Interactive API Playground to run requests directly in your browser.

TradeWatch Interactive API Playground

Resources

Quick Start

  1. Create an API key in the TradeWatch Dashboard.
  2. Follow platform setup docs: Getting started.

Available Methods

account

Method Required Params Summary Description
getUsage() - Usage statistics Get the usage statistics of your API account

currencies

Method Required Params Summary Description
convert(from, to) from, to Conversion Convert one symbol to another
getHistoricalOhlc(symbol, resolution, start, end) symbol, resolution, start, end Get Historical Ohlc Get historical OHLC candles for a symbol in a selected resolution and time range.
getHistoricalTicks(symbol, start, end) symbol, start, end Get Historical Ticks Get raw historical ticks for a symbol in a selected time range using cursor pagination.
getInsights() - Get Insights Get recent currencies insights.
getQuote(symbol) symbol Last Quote Get the last quote tick for the provided symbol.
getQuotes(symbols) symbols Last Quotes Get the last quote tick for the provided symbols.
getSymbols() - Available Symbols Get list of available symbols

crypto

Method Required Params Summary Description
convert(from, to) from, to Conversion Convert one symbol to another
getExchanges() - Available Exchanges Get list of available cryptocurrency exchanges
getHistoricalOhlc(symbol, resolution, start, end) symbol, resolution, start, end Get Historical Ohlc Get historical OHLC candles for a symbol in a selected resolution and time range.
getHistoricalTicks(symbol, start, end) symbol, start, end Get Historical Ticks Get raw historical ticks for a symbol in a selected time range using cursor pagination.
getInsights() - Get Insights Get recent crypto insights.
getQuote(symbol) symbol Last Quote Get the last quote tick for the provided symbol.
getQuotes(symbols) symbols Last Quotes Get the last quote tick for the provided symbols.
getSymbols() - Available Symbols Get list of available symbols

indices

Method Required Params Summary Description
getHistoricalOhlc(symbol, resolution, start, end) symbol, resolution, start, end Get Historical Ohlc Get historical OHLC candles for a symbol in a selected resolution and time range.
getHistoricalTicks(symbol, start, end) symbol, start, end Get Historical Ticks Get raw historical ticks for a symbol in a selected time range using cursor pagination.
getInsights() - Get Insights Get recent indices insights.
getQuote(symbol) symbol Last Quote Get the last quote tick for the provided symbol.
getQuotes(symbols) symbols Last Quotes Get the last quote tick for the provided symbols.
getSymbols() - Available Symbols Get list of available symbols

stocks

Method Required Params Summary Description
getHistoricalOhlc(symbol, resolution, start, end) symbol, resolution, start, end Get Historical Ohlc Get historical OHLC candles for a symbol in a selected resolution and time range.
getHistoricalTicks(symbol, start, end) symbol, start, end Get Historical Ticks Get raw historical ticks for a symbol in a selected time range using cursor pagination.
getInsights() - Get Insights Get recent stocks insights.
getMarketHolidays(start, end) start, end Get Market Holidays Get market holidays. It takes half-days into account.
getMarketStatus() - Get Market Status Get the current status (open or closed) of a market. It takes holidays and half-days into account but does not factor in circuit breakers or halts.
getMarkets() - Get Markets Get details about the markets available in this API.
getQuote(symbol) symbol Last Quote Get the last quote tick for the provided symbol.
getQuotes(symbols) symbols Last Quotes Get the last quote tick for the provided symbols.
getStockData(symbol) symbol Get Stock Data Get Stock Data
getSymbols() - Available Symbols Get list of available symbols
getTradingHours(start, end) start, end Get Trading Hours Get trading hours. It takes half-days into account.
stockGetCountries() - Available Countries Get list of available countries

commodities

Method Required Params Summary Description
getHistoricalOhlc(symbol, resolution, start, end) symbol, resolution, start, end Get Historical Ohlc Get historical OHLC candles for a symbol in a selected resolution and time range.
getHistoricalTicks(symbol, start, end) symbol, start, end Get Historical Ticks Get raw historical ticks for a symbol in a selected time range using cursor pagination.
getInsights() - Get Insights Get recent commodities insights.
getQuote(symbol) symbol Last Quote Get the last quote tick for the provided symbol.
getQuotes(symbols) symbols Last Quotes Get the last quote tick for the provided symbols.
getSymbols() - Available Symbols Get list of available symbols
getTypes() - Available Types Get list of available commodity types

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages