Skip to content

Aspens API Protocol Documentation

Table of Contents

Arborter is the name of the service.

arborter.proto

Empty

Order

rpc: SendOrder

Field	Type	Label	Description
side	string		`bid` or `ask`
quantity	uint64		order size
price	uint64		optional. including is a LIMIT order. excluding is a MARKET order.
market_name	string		the handle for this market. eg. `market-1`
trade_symbol	string		`BASE_SYMBOL:QUOTE_SYMBOL` eg. `WTI:USD`
participant_id	string		uuid, eg. `00000000-0000-0000-0000-000000000000`
base_address	string		Base symbol (WTI) chain address
quote_address	string		Quote sybmol (USD) chain address
execution_type	string		`direct` or `discretionary`
matching_order_id	string		when execution_type == `discretionary`, include `order_id` to match with.

SendOrderResponse

Field	Type	Label	Description
result	string
message	string

ArborterService

Method Name	Request Type	Response Type	Description
SendOrder	Order	SendOrderResponse

Scalar Value Types

.proto Type	C++	Java	Python	Go	C#	PHP	Ruby
double	double	double	float	float64	double	float	Float
float	float	float	float	float32	float	float	Float
int32	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	int64	long	int/long	int64	long	integer/string	Bignum
uint32	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	int64	long	int/long	int64	long	integer/string	Bignum
bool	bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)