tvsignal
v1.0.6
Published
TradingView idea & signal parser
Downloads
3
Readme
tvSignal
TradingView idea & signal parser
Installation
npm i tvsignal
Usage
- Ideas
import { Ideas } from "tvsignal"
const ideas = await Ideas.get(/* Filter object */)
/**
ideas = [
{
title: string
symbol: string
side: "SHORT" | "LONG"
link: string
image: string
caption: string
author: string | {
id: number
username: string
avatar: string
isPro: boolean
charts: number
followers: number
reputation: number
}
}
]
*/
- Signal
import { Chart } from "tvsignal"
const signal = await Chart.signal(/* Chart link */)
/**
# When chart includes a signal
signal = {
symbol: string
base: string
quote: string
exchange: string
entryPrice: number
target: number
stoploss: number
side: "SHORT" | "LONG"
timeframe: string
expireAt: Date
}
# When chart not includes any signal
signal = null
*/
- User
import { User } from "tvsignal"
const user = await User.info(/* Username */)
/**
# When the user is found
user = {
id: number
username: string
avatar: string
isPro: boolean
charts: number
followers: number
reputation: number
}
# When the user is not found
user = null
*/