Class: default

client/apis/TradesAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• acceptTrade
• canTradeWith
• counterTrade
• declineTrade
• getTrade
• getTradesByStatusType
• getTradesCountByStatusType
• getTradesMetaData
• request
• sendTrade

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/TradesAPI.ts:104

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

acceptTrade

▸ acceptTrade(options: AcceptTradeOptions): Promise<unknown>

Parameters:

Name	Type
options	AcceptTradeOptions

Returns: Promise<unknown>

Defined in: client/apis/TradesAPI.ts:167

---

canTradeWith

▸ canTradeWith(options: CanSelfTradeWithUserOptions): Promise<CanSelfTradeWithUser>

Parameters:

Name	Type
options	CanSelfTradeWithUserOptions

Returns: Promise<CanSelfTradeWithUser>

Defined in: client/apis/TradesAPI.ts:156

---

counterTrade

▸ counterTrade(options: CounterTradeOptions): Promise<CounterTrade>

Parameters:

Name	Type
options	CounterTradeOptions

Returns: Promise<CounterTrade>

Defined in: client/apis/TradesAPI.ts:179

---

declineTrade

▸ declineTrade(options: DeclineTradeOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineTradeOptions

Returns: Promise<unknown>

Defined in: client/apis/TradesAPI.ts:192

---

getTrade

▸ getTrade(options: GetTradeOptions): Promise<GetTrade>

Parameters:

Name	Type
options	GetTradeOptions

Returns: Promise<GetTrade>

Defined in: client/apis/TradesAPI.ts:112

---

getTradesByStatusType

▸ getTradesByStatusType(options: GetTradesByStatusTypeOptions): Promise<GetTradesByStatusType>

Parameters:

Name	Type
options	GetTradesByStatusTypeOptions

Returns: Promise<GetTradesByStatusType>

Defined in: client/apis/TradesAPI.ts:123

---

getTradesCountByStatusType

▸ getTradesCountByStatusType(options: GetTradesCountByStatusTypeOptions): Promise<GetTradesCountByStatusType>

Parameters:

Name	Type
options	GetTradesCountByStatusTypeOptions

Returns: Promise<GetTradesCountByStatusType>

Defined in: client/apis/TradesAPI.ts:134

---

getTradesMetaData

▸ getTradesMetaData(): Promise<GetTradesMetaData>

Returns: Promise<GetTradesMetaData>

Defined in: client/apis/TradesAPI.ts:145

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

sendTrade

▸ sendTrade(options: Pick<CounterTradeOptions, offers>): Promise<SendTrade>

Parameters:

Name	Type
options	Pick<CounterTradeOptions, offers>

Returns: Promise<SendTrade>

Defined in: client/apis/TradesAPI.ts:204