Namespace GetOrderbookPreSubmit

Types of GetOrderbookPreSubmit request

Index

Type aliases

Type aliases

RequestQuery

RequestQuery: { action: string; authAddress: string; quantity: number; ticker: string }

Type of GetOrderbookPreSubmit query parameters

Data representing requirement of client to obtain certain position in the market when and if it matches

Type declaration

action: string

Type of the Order action
authAddress: string

Ethereum address of requester required for authentication
quantity: number

Address of ERC20 token used for premium to define Orderbook
ticker: string

Hash of the Ticker to define Orderbook

ResponseBody

ResponseBody: { pay: { fee: string; margin: string; position: number }; receive: { margin: string; position: number } }

Type of GetOrderbookPreSubmit response body

Object with the pre-calculation of the required actions to be done in order to fulfill client's requirements

Type declaration

pay: { fee: string; margin: string; position: number }

Section describing positions, margin and fees that client would pay
- fee: string
  
  Amount of fees that client would pay for orders settlement
- margin: string
  
  Amount of margin that client would lock for creating new positions
- position: number
  
  Amount of positions that client would sell on 2ry market
receive: { margin: string; position: number }

Section describing positions and margin that client would receive
- margin: string
  
  Amount of margin client would receive from reselling it's positions on 2ry market
- position: number
  
  Amount of new positions client would receive
  
  LONG / SHORT position depends on Order.action

Generated using TypeDoc