Search
Preparing search index...
The search index is not available
@neon-exchange/api-client-typescript - v5.0.27
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"src/types/client"
NashSocketEvents
Interface NashSocketEvents
Hierarchy
NashSocketEvents
Index
Properties
absinthe
Socket
disconnect
socket
Methods
on
Account
Trade
on
New
Trades
on
Updated
Account
Orders
on
Updated
Candles
on
Updated
Orderbook
on
Updated
Tickers
Properties
absinthe
Socket
absinthe
Socket
:
InstanceType
<
AbsintheSocket
>
disconnect
disconnect
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
socket
socket
:
InstanceType
<
PhoenixSocket
>
See
https://www.npmjs.com/package/phoenix-channels
Methods
on
Account
Trade
on
Account
Trade
(
variables
:
{
marketName
:
string
}
, handlers
:
SubscriptionHandlers
<
{
data
:
{
newAccountTrades
:
Trade
[]
}
}
>
)
:
void
Parameters
variables:
{
marketName
:
string
}
market
Name
:
string
handlers:
SubscriptionHandlers
<
{
data
:
{
newAccountTrades
:
Trade
[]
}
}
>
Returns
void
on
New
Trades
on
New
Trades
(
variables
:
{
marketName
:
string
}
, handlers
:
SubscriptionHandlers
<
{
data
:
{
newTrades
:
Trade
[]
}
}
>
)
:
void
Parameters
variables:
{
marketName
:
string
}
market
Name
:
string
handlers:
SubscriptionHandlers
<
{
data
:
{
newTrades
:
Trade
[]
}
}
>
Returns
void
on
Updated
Account
Orders
on
Updated
Account
Orders
(
variables
:
{
buyOrSell
?:
OrderBuyOrSell
;
marketName
?:
string
;
rangeStart
?:
DateTime
;
rangeStop
?:
DateTime
;
status
?:
OrderStatus
[]
;
type
?:
OrderType
[]
}
, handlers
:
SubscriptionHandlers
<
{
data
:
{
updatedAccountOrders
:
Order
[]
}
}
>
)
:
void
Parameters
variables:
{
buyOrSell
?:
OrderBuyOrSell
;
marketName
?:
string
;
rangeStart
?:
DateTime
;
rangeStop
?:
DateTime
;
status
?:
OrderStatus
[]
;
type
?:
OrderType
[]
}
Optional
buy
OrSell
?:
OrderBuyOrSell
Optional
market
Name
?:
string
Optional
range
Start
?:
DateTime
Optional
range
Stop
?:
DateTime
Optional
status
?:
OrderStatus
[]
Optional
type
?:
OrderType
[]
handlers:
SubscriptionHandlers
<
{
data
:
{
updatedAccountOrders
:
Order
[]
}
}
>
Returns
void
on
Updated
Candles
on
Updated
Candles
(
variables
:
{
interval
:
CandleInterval
;
marketName
:
string
}
, handlers
:
SubscriptionHandlers
<
{
data
:
{
updatedCandles
:
CandleRange
[]
}
}
>
)
:
void
Parameters
variables:
{
interval
:
CandleInterval
;
marketName
:
string
}
interval
:
CandleInterval
market
Name
:
string
handlers:
SubscriptionHandlers
<
{
data
:
{
updatedCandles
:
CandleRange
[]
}
}
>
Returns
void
on
Updated
Orderbook
on
Updated
Orderbook
(
variables
:
{
marketName
:
string
}
, handlers
:
SubscriptionHandlers
<
{
data
:
{
updatedOrderBook
:
OrderBook
}
}
>
)
:
void
Parameters
variables:
{
marketName
:
string
}
market
Name
:
string
handlers:
SubscriptionHandlers
<
{
data
:
{
updatedOrderBook
:
OrderBook
}
}
>
Returns
void
on
Updated
Tickers
on
Updated
Tickers
(
handlers
:
SubscriptionHandlers
<
{
data
:
{
updatedTickers
:
Ticker
[]
}
}
>
)
:
void
Parameters
handlers:
SubscriptionHandlers
<
{
data
:
{
updatedTickers
:
Ticker
[]
}
}
>
Returns
void
Globals
"src/types/client"
Client
Mode
GQL
GQLError
GQLMutation
Params
GQLQuery
Params
GQLResp
Nash
Socket
Events
absinthe
Socket
disconnect
socket
on
Account
Trade
on
New
Trades
on
Updated
Account
Orders
on
Updated
Candles
on
Updated
Orderbook
on
Updated
Tickers
Payload
Signature
Subscription
Handlers
Generated using
TypeDoc
See https://www.npmjs.com/package/phoenix-channels