SpotSpin | @spinfi/core

Hierarchy

SpotSpin

Methods

batchOps

batchOps(request: BatchOpsRequest, config?: BatchOpsConfig): Promise<BatchOpsResponse>

- Defined in src/spot/api.types.ts:95
Method allows you to perform many operations within a single transaction
example
```
const response = await spin.batchOps(request);
```
Parameters
- request: BatchOpsRequest
- Optional config: BatchOpsConfig
Returns Promise<BatchOpsResponse>

bundle

bundle(units?: spot.SpotBundlerUnit[]): spot.SpotBundler

- Defined in src/spot/api.types.ts:575
Bundler

Parameters
- Optional units: spot.SpotBundlerUnit[]
Returns spot.SpotBundler

cancelOrder

cancelOrder(request: spot.CancelOrderRequest, config?: spot.CancelOrderConfig): Promise<spot.CancelOrderResponse>

- Defined in src/spot/api.types.ts:104
Cancel an order for a specified market by order ID
example
```
const response = await spin.cancelOrder(request);
```
Parameters
- request: spot.CancelOrderRequest
- Optional config: spot.CancelOrderConfig
Returns Promise<spot.CancelOrderResponse>

cancelOrders

cancelOrders(request: spot.CancelOrdersRequest, config?: spot.CancelOrdersConfig): Promise<spot.CancelOrdersResponse>

- Defined in src/spot/api.types.ts:116
Cancel all user orders for a specified market
example
```
const response = await spin.cancelOrders(request);
```
Parameters
- request: spot.CancelOrdersRequest
- Optional config: spot.CancelOrdersConfig
Returns Promise<spot.CancelOrdersResponse>

deposit

deposit(request: spot.DepositRequest, config?: spot.DepositConfig): Promise<spot.DepositResponse>

- Defined in src/spot/api.types.ts:128
Deposit ft and near
example
```
const response = await spin.deposit(request);
```
Parameters
- request: spot.DepositRequest
- Optional config: spot.DepositConfig
Returns Promise<spot.DepositResponse>

depositNear

depositNear(request: DepositNearRequest, config?: DepositNearConfig): Promise<DepositNearResponse>

- Defined in src/spot/api.types.ts:139
NEAR token is transferred by attaching them to a transaction. The attached amount will be credited to the trading account. To deposit Fungible Token use it's contract methods
example
```
const response = await spin.depositNear(request);
```
Parameters
- request: DepositNearRequest
- Optional config: DepositNearConfig
Returns Promise<DepositNearResponse>

depositStorage

depositStorage(request: DepositStorageRequest, config?: DepositStorageConfig): Promise<DepositStorageResponse>

- Defined in src/spot/api.types.ts:315
TODO

Parameters
- request: DepositStorageRequest
- Optional config: DepositStorageConfig
Returns Promise<DepositStorageResponse>

getBalance

getBalance(request: GetBalanceRequest): Promise<string>

- Defined in src/spot/api.types.ts:260
Get balance
example
```
const response = await spin.getBalance(request);
```
Parameters
- request: GetBalanceRequest
Returns Promise<string>

getBalanceFt

getBalanceFt(request: GetBalanceFtRequest): Promise<string>

- Defined in src/spot/api.types.ts:269
Get balance ft
example
```
const response = await spin.getBalanceFt(request);
```
Parameters
- request: GetBalanceFtRequest
Returns Promise<string>

getBalanceNear

getBalanceNear(request: GetBalanceNearRequest): Promise<string>

- Defined in src/spot/api.types.ts:278
Get balance near
example
```
const response = await spin.getBalanceNear(request);
```
Parameters
- request: GetBalanceNearRequest
Returns Promise<string>

getBalanceStorage

getBalanceStorage(request: GetBalanceStorageRequest): Promise<GetBalanceStorageResponse>

- Defined in src/spot/api.types.ts:287
Get balance storage
example
```
const response = await spin.getBalanceStorage(request);
```
Parameters
- request: GetBalanceStorageRequest
Returns Promise<GetBalanceStorageResponse>

getBalanceStorageBounds

getBalanceStorageBounds(request: GetBalanceStorageBoundsRequest): Promise<GetBalanceStorageBoundsResponse>

- Defined in src/spot/api.types.ts:309
TODO

Parameters
- request: GetBalanceStorageBoundsRequest
Returns Promise<GetBalanceStorageBoundsResponse>

getCandles

getCandles(request: GetCandlesRequest, config?: MethodConfig<GetCandlesResponse>): Subscription

- Defined in src/spot/api.types.ts:335
Returns history of candles to use in OHLC chart
example
```
const unsubscribe = spin.getCandles(request, {
  onOk: (data) => console.log(data),
  onError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: GetCandlesRequest
- Optional config: MethodConfig<GetCandlesResponse>
Returns Subscription

getCurrencies

getCurrencies(request: GetCurrenciesRequest): Promise<GetCurrenciesResponse>

- Defined in src/spot/api.types.ts:151
Returns all currencies supported by the contract
example
```
const response = await spin.getCurrencies(request);
```
Parameters
- request: GetCurrenciesRequest
Returns Promise<GetCurrenciesResponse>

getDeposits

getDeposits(request: GetDepositsRequest): Promise<GetDepositsResponse>

- Defined in src/spot/api.types.ts:160
Returns account balannces by account ID
example
```
const response = await spin.getDeposits(request);
```
Parameters
- request: GetDepositsRequest
Returns Promise<GetDepositsResponse>

getDryRunSwap

getDryRunSwap(request: GetDryRunSwapRequest): Promise<GetDryRunSwapResponse>

- Defined in src/spot/api.types.ts:248
TODO

Parameters
- request: GetDryRunSwapRequest
Returns Promise<GetDryRunSwapResponse>

getMarket

getMarket(request: spot.GetMarketRequest): Promise<spot.Market>

- Defined in src/spot/api.types.ts:169
Returns market info by ID supported by the contract
example
```
const response = await spin.getMarket(request);
```
Parameters
- request: spot.GetMarketRequest
Returns Promise<spot.Market>

getMarkets

getMarkets(): Promise<spot.GetMarketsResponse>

- Defined in src/spot/api.types.ts:178
Returns all markets info supported by the contract
example
```
const response = await spin.getMarkets();
```
Returns Promise<spot.GetMarketsResponse>

getOrder

getOrder(request: spot.GetOrderRequest): Promise<spot.Order>

- Defined in src/spot/api.types.ts:187
Returns the current information about order by market ID, order ID and account ID
example
```
const response = await spin.getOrder(request);
```
Parameters
- request: spot.GetOrderRequest
Returns Promise<spot.Order>

getOrderbook

getOrderbook(request: spot.GetOrderbookRequest): Promise<spot.GetOrderbookResponse>

- Defined in src/spot/api.types.ts:196
Returns the order book information for a given market ID
example
```
const response = await spin.getOrderbook(request);
```
Parameters
- request: spot.GetOrderbookRequest
Returns Promise<spot.GetOrderbookResponse>

getOrders

getOrders(request: spot.GetOrdersRequest): Promise<spot.GetOrdersResponse>

- Defined in src/spot/api.types.ts:205
Returns a list of orders belonging to a given account on a specified market
example
```
const response = await spin.getOrders(request);
```
Parameters
- request: spot.GetOrdersRequest
Returns Promise<spot.GetOrdersResponse>

getOrdersHistory

getOrdersHistory(request: spot.GetOrdersHistoryRequest, config?: MethodConfig<spot.GetOrdersHistoryResponse>): Subscription

- Defined in src/spot/api.types.ts:352
Returns history of orders that have been partially or fully filled, cancelled or expired
example
```
const unsubscribe = spin.getOrdersHistory(request, {
  onOk: (data) => console.log(data),
  onError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.GetOrdersHistoryRequest
- Optional config: MethodConfig<spot.GetOrdersHistoryResponse>
Returns Subscription

getTrades

getTrades(request: spot.GetTradesRequest, config?: MethodConfig<spot.GetTradesResponse>): Subscription

- Defined in src/spot/api.types.ts:369
Returns the latest trades that have occurred for instruments in a specific market ID
example
```
const unsubscribe = spin.getTrades(request, {
  onOk: (data) => console.log(data),
  onError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.GetTradesRequest
- Optional config: MethodConfig<spot.GetTradesResponse>
Returns Subscription

getTransactionStatus

getTransactionStatus(request: GetTransactionStatusRequest): Promise<FinalExecutionOutcome>

- Defined in src/spot/api.types.ts:303
TODO

Parameters
- request: GetTransactionStatusRequest
Returns Promise<FinalExecutionOutcome>

getUserTrades

getUserTrades(request: spot.GetUserTradesRequest, config?: MethodConfig<spot.GetUserTradesResponse>): Subscription

- Defined in src/spot/api.types.ts:383
Returns the latest trades of a specific user
example
```
const unsubscribe = spin.getUserTrades(request, {
  onOk: (data) => console.log(data),
  onError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.GetUserTradesRequest
- Optional config: MethodConfig<spot.GetUserTradesResponse>
Returns Subscription

listenAccountBalances

listenAccountBalances(request: ListenAccountBalancesRequest, config?: NotifyWithStateConfig<AccountBalancesState, AccountBalancesNotify>): Subscription

Subscribes to the balance changes stream of a particular account by it's ID

example

const unsubscribe = spin.listenAccountBalances(request, {
  onNotifyOk: (data) => console.log(data),
  onStateOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
  onStateError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: ListenAccountBalancesRequest
Optional config: NotifyWithStateConfig<AccountBalancesState, AccountBalancesNotify>

Returns Subscription

listenAccountOrders

listenAccountOrders(request: spot.ListenAccountOrdersRequest, config?: NotifyWithStateConfig<spot.AccountOrdersState, spot.OrderInfo>): Subscription

Subscribes to the all orders stream of a particular account by it's ID

example

const unsubscribe = spin.listenAccountOrders(request, {
  onNotifyOk: (data) => console.log(data),
  onStateOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
  onStateError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: spot.ListenAccountOrdersRequest
Optional config: NotifyWithStateConfig<spot.AccountOrdersState, spot.OrderInfo>

Returns Subscription

listenAccountTrades

listenAccountTrades(request: spot.ListenAccountTradesRequest, config?: NotifyConfig<spot.Trade>): Subscription

Subscribes to the trades stream of a particular account by it's ID

example

const unsubscribe = spin.listenAccountTrades(request, {
  onNotifyOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: spot.ListenAccountTradesRequest
Optional config: NotifyConfig<spot.Trade>

Returns Subscription

listenBookL1

listenBookL1(request: spot.ListenBookL1Request, config?: NotifyConfig<Book>): Subscription

- Defined in src/spot/api.types.ts:473
Subscribe to the orderbook L1 data. Notifications are sent every time when best bid or best ask were changed. That changes couldn't be generated more often than block is validated and added in near blockchain, but there can be be multiple changes within one block. Messages order is guaranteed
example
```
const unsubscribe = spin.listenBookL1(request, {
  onNotifyOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.ListenBookL1Request
- Optional config: NotifyConfig<Book>
Returns Subscription

listenBookL2

listenBookL2(request: spot.ListenBookL2Request, config?: NotifyConfig<Book>): Subscription

- Defined in src/spot/api.types.ts:494
Subscribe to the orderbook L2 data. L2 data consists a snapshot of the bids/asks prices and quantities with a specific depth. Right now notifications are sent every 100 millisecond, but don't forget that each block in blockchain is generated approximately 1 second, so the average time of this type of notification approximately 1 second too. If there is no changes in orderbook notifications won't be sent.
example
```
const unsubscribe = spin.listenBookL2(request, {
  onNotifyOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.ListenBookL2Request
- Optional config: NotifyConfig<Book>
Returns Subscription

listenBookL3

listenBookL3(request: spot.ListenBookL3Request, config?: NotifyWithStateConfig<Book, spot.BookL3Notify>): Subscription

- Defined in src/spot/api.types.ts:518
Subscribe to the orderbook L3 data. In response you receive an initial snapshot of the orderbook. There is a last_change_id field that is used to validate integrity of the orderbook events sequence. Each next notification will have a sequentially increasing number by 1 in the id field. Each notification means absolutely quantity for a given price level. If quantity is 0, it means there are no orders for a given price level.
example
```
const unsubscribe = spin.listenBookL3(request, {
  onNotifyOk: (data) => console.log(data),
  onStateOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
  onStateError: (error) => console.error(error),
});

unsubscribe();
```
Parameters
- request: spot.ListenBookL3Request
- Optional config: NotifyWithStateConfig<Book, spot.BookL3Notify>
Returns Subscription

listenOrders

listenOrders(request: ListenOrdersRequest, config?: NotifyConfig<spot.OrderInfo>): Subscription

Subscribes to the all orders stream of a particular market by it's id

example

const unsubscribe = spin.listenOrders(request, {
  onNotifyOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: ListenOrdersRequest
Optional config: NotifyConfig<spot.OrderInfo>

Returns Subscription

listenTrades

listenTrades(request: spot.ListenTradesRequest, config?: NotifyConfig<spot.Trade>): Subscription

Subscribes to the trades stream of a particular market by it's id

example

const unsubscribe = spin.listenTrades(request, {
  onNotifyOk: (data) => console.log(data),
  onSubOk: (data) => console.log(data),
  onUnsubOk: (data) => console.log(data),
  onSubError: (error) => console.error(error),
  onUnsubError: (error) => console.error(error),
  onNotifyError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: spot.ListenTradesRequest
Optional config: NotifyConfig<spot.Trade>

Returns Subscription

ping

ping(request: void, config?: MethodConfig<"pong">): Subscription

Health check method for gateway API

example

const unsubscribe = spin.ping(undefined, {
  onOk: (data) => console.log(data),
  onError: (error) => console.error(error),
});

unsubscribe();

Parameters

request: void
Optional config: MethodConfig<"pong">

Returns Subscription

placeAsk

placeAsk(request: spot.PlaceAskRequest, config?: spot.PlaceAskConfig): Promise<spot.PlaceAskResponse>

- Defined in src/spot/api.types.ts:214
Place ask
example
```
const response = await spin.placeAsk(request);
```
Parameters
- request: spot.PlaceAskRequest
- Optional config: spot.PlaceAskConfig
Returns Promise<spot.PlaceAskResponse>

placeBid

placeBid(request: spot.PlaceAskRequest, config?: spot.PlaceBidConfig): Promise<spot.PlaceBidResponse>

- Defined in src/spot/api.types.ts:223
Place bid
example
```
const response = await spin.placeBid(request);
```
Parameters
- request: spot.PlaceAskRequest
- Optional config: spot.PlaceBidConfig
Returns Promise<spot.PlaceBidResponse>

swap

swap(request: SwapRequest, config?: SwapConfig): Promise<SwapResponse>

- Defined in src/spot/api.types.ts:236
TODO

Parameters
- request: SwapRequest
- Optional config: SwapConfig
Returns Promise<SwapResponse>

swapFt

swapFt(request: SwapFtRequest, config?: SwapFtConfig): Promise<SwapFtResponse>

- Defined in src/spot/api.types.ts:240
TODO

Parameters
- request: SwapFtRequest
- Optional config: SwapFtConfig
Returns Promise<SwapFtResponse>

swapNear

swapNear(request: SwapNearRequest, config?: SwapNearConfig): Promise<SwapNearResponse>

- Defined in src/spot/api.types.ts:244
TODO

Parameters
- request: SwapNearRequest
- Optional config: SwapNearConfig
Returns Promise<SwapNearResponse>

transferFt

transferFt(request: TransferFtRequest, config?: TransferFtConfig): Promise<TransferFtResponse>

- Defined in src/spot/api.types.ts:296
Transfer ft
example
```
const response = await spin.transferFt(request);
```
Parameters
- request: TransferFtRequest
- Optional config: TransferFtConfig
Returns Promise<TransferFtResponse>

withdraw

withdraw(request: spot.WithdrawRequest, config?: spot.WithdrawConfig): Promise<spot.WithdrawResponse>

- Defined in src/spot/api.types.ts:232
Withdraws token from the trading account to the user's account
example
```
const response = await spin.withdraw(request);
```
Parameters
- request: spot.WithdrawRequest
- Optional config: spot.WithdrawConfig
Returns Promise<spot.WithdrawResponse>

Hierarchy

Index

Methods

Methods

batchOps

Parameters

request: BatchOpsRequest

Optional config: BatchOpsConfig

Returns Promise<BatchOpsResponse>

bundle

Parameters

Optional units: spot.SpotBundlerUnit[]

Returns spot.SpotBundler

cancelOrder

Parameters

request: spot.CancelOrderRequest

Optional config: spot.CancelOrderConfig

Returns Promise<spot.CancelOrderResponse>

cancelOrders

Parameters

request: spot.CancelOrdersRequest

Optional config: spot.CancelOrdersConfig

Returns Promise<spot.CancelOrdersResponse>

deposit

Parameters

request: spot.DepositRequest

Optional config: spot.DepositConfig

Returns Promise<spot.DepositResponse>

depositNear

Parameters

request: DepositNearRequest

Optional config: DepositNearConfig

Returns Promise<DepositNearResponse>

depositStorage

Parameters

request: DepositStorageRequest

Optional config: DepositStorageConfig

Returns Promise<DepositStorageResponse>

getBalance

Parameters

request: GetBalanceRequest

Returns Promise<string>

getBalanceFt

Parameters

request: GetBalanceFtRequest

Returns Promise<string>

getBalanceNear

Parameters

request: GetBalanceNearRequest

Returns Promise<string>

getBalanceStorage

Parameters

request: GetBalanceStorageRequest

Returns Promise<GetBalanceStorageResponse>

getBalanceStorageBounds

Parameters

request: GetBalanceStorageBoundsRequest

Returns Promise<GetBalanceStorageBoundsResponse>

getCandles

Parameters

request: GetCandlesRequest

Optional config: MethodConfig<GetCandlesResponse>

Returns Subscription

getCurrencies

Parameters

request: GetCurrenciesRequest

Returns Promise<GetCurrenciesResponse>

getDeposits

Parameters

request: GetDepositsRequest

Returns Promise<GetDepositsResponse>

getDryRunSwap

Parameters

request: GetDryRunSwapRequest

Returns Promise<GetDryRunSwapResponse>

getMarket

Parameters

request: spot.GetMarketRequest

Returns Promise<spot.Market>

getMarkets