Skip to content

Module: client/apis/TradesAPI

Table of contents

Classes

Type aliases

Type aliases

AcceptTrade

Ƭ AcceptTrade: unknown

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


AcceptTradeOptions

Ƭ AcceptTradeOptions: object

Type declaration:

Name Type
tradeId number

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


CanSelfTradeWithUser

Ƭ CanSelfTradeWithUser: object

Type declaration:

Name Type
canTrade boolean
status string

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


CanSelfTradeWithUserOptions

Ƭ CanSelfTradeWithUserOptions: object

Type declaration:

Name Type
userId number

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


CounterTrade

Ƭ CounterTrade: object

Type declaration:

Name Type
id number

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


CounterTradeOptions

Ƭ CounterTradeOptions: object

Type declaration:

Name Type
offers { robux: number ; userAssetIds: number[] ; userId: number }[]
tradeId number

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


DeclineTrade

Ƭ DeclineTrade: unknown

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


DeclineTradeOptions

Ƭ DeclineTradeOptions: object

Type declaration:

Name Type
tradeId number

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


GetTrade

Ƭ GetTrade: object

Type declaration:

Name Type
created string
expiration string
id number
isActive boolean
offers { robux: number ; user: { displayName: string ; id: number ; name: string } ; userAssets: { assetId: number ; assetStock: number ; id: number ; membershipType: None | string ; name: string ; originalPrice: number ; recentAveragePrice: number ; serialNumber: number }[] }[]
status string
user object
user.displayName string
user.id number
user.name string

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


GetTradeOptions

Ƭ GetTradeOptions: object

Type declaration:

Name Type
tradeId number

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


GetTradesByStatusType

Ƭ GetTradesByStatusType: object

Type declaration:

Name Type
data { created: string ; expiration: string ; id: number ; isActive: boolean ; status: string ; user: { displayName: string ; id: number ; name: string } }[]
nextPageCursor string
previousPageCursor string

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


GetTradesByStatusTypeOptions

Ƭ GetTradesByStatusTypeOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
tradeStatusType Inbound | Outbound | Completed | Inactive

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


GetTradesCountByStatusType

Ƭ GetTradesCountByStatusType: object

Type declaration:

Name Type
count number

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


GetTradesCountByStatusTypeOptions

Ƭ GetTradesCountByStatusTypeOptions: object

Type declaration:

Name Type
tradeStatusType GetTradesByStatusTypeOptions[tradeStatusType]

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


GetTradesMetaData

Ƭ GetTradesMetaData: object

Type declaration:

Name Type
maxItemsPerSide number
minValueRatio number
tradeSystemMaxRobuxPercent number
tradeSystemRobuxFee number

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


SendTrade

Ƭ SendTrade: object

Type declaration:

Name Type
id number

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


SendTradeOptions

Ƭ SendTradeOptions: Omit<CounterTradeOptions, tradeId>

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