Skip to content

Module: client/apis/EconomyAPI

Table of contents

Classes

Type aliases

Type aliases

GetAssetResaleData

Ƭ GetAssetResaleData: object

Type declaration:

Name Type
assetStock number
numberRemaining number
originalPrice number
priceDataPoints { date: string ; value: number }[]
recentAveragePrice number
sales number
volumeDataPoints { date: string ; value: number }[]

Defined in: client/apis/EconomyAPI.ts:9

GetAssetResaleDataOptions

Ƭ GetAssetResaleDataOptions: object

Type declaration:

Name Type
assetId number

Defined in: client/apis/EconomyAPI.ts:6

GetAssetResellers

Ƭ GetAssetResellers: object

Type declaration:

Name Type
data { price: number ; seller: { id: number ; name: string ; type: User | Group } ; serialNumber: number ; userAssetId: number }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/EconomyAPI.ts:29

GetAssetResellersOptions

Ƭ GetAssetResellersOptions: object

Type declaration:

Name Type
assetId number
cursor? string
limit? 10 | 25 | 50 | 100

Defined in: client/apis/EconomyAPI.ts:24

GetDeveloperExchangeAbility

Ƭ GetDeveloperExchangeAbility: object

Type declaration:

Name Type
canCashOut boolean
hasCashedOutThisMonth boolean
hasVerifiedEmail boolean
isUserBlackListed boolean
lastImbursementStatusIsValid boolean
meetsMinimumCashOutBalance boolean
meetsPremiumRequirement boolean

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

GetDeveloperExchangeHelp

Ƭ GetDeveloperExchangeHelp: unknown

Defined in: client/apis/EconomyAPI.ts:69

GetDeveloperExchangeInfo

Ƭ GetDeveloperExchangeInfo: object

Type declaration:

Name Type
canProceedToCashout boolean
conversionPercent number
currencyOperationErrorMessage string
emailIsVerified boolean
hasCurrencyOperationError boolean
isImbursementBlacklistUser boolean
lastImbursementStatus string
lastImbursementSubmissionDate string
maxRobuxCanCashOut number
meetsMembershipRequirements boolean
minRobuxToCashOut number
percentRobux number
showOnlyExchangeRates boolean
showProgressBar boolean

Defined in: client/apis/EconomyAPI.ts:73

GetDeveloperExchangeInfoOptions

Ƭ GetDeveloperExchangeInfoOptions: object

Type declaration:

Name Type
fromDevExPage boolean

Defined in: client/apis/EconomyAPI.ts:70

GetGroupCurrency

Ƭ GetGroupCurrency: object

Type declaration:

Name Type
robux number

Defined in: client/apis/EconomyAPI.ts:106

GetGroupCurrencyOptions

Ƭ GetGroupCurrencyOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/EconomyAPI.ts:103

GetGroupRevenueSummaryInTimeFrame

Ƭ GetGroupRevenueSummaryInTimeFrame: object

Type declaration:

Name Type
groupPayoutRobux number
itemSaleRobux number
pendingRobux number
purchasedRoblox number
recurringRobuxStipend number
tradeSystemRobux number

Defined in: client/apis/EconomyAPI.ts:119

GetGroupRevenueSummaryInTimeFrameOptions

Ƭ GetGroupRevenueSummaryInTimeFrameOptions: object

Type declaration:

Name Type
groupId number
timeFrame Day | Week | Month | Year

Defined in: client/apis/EconomyAPI.ts:115

GetGroupTransactions

Ƭ GetGroupTransactions: object

Type declaration:

Name Type
data { agent: { id: number ; name: string ; type: User | Group } ; created: string ; currency: { amount: number ; type: Robux | string } ; details: unknown ; isPending: boolean }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/EconomyAPI.ts:137

GetGroupTransactionsOptions

Ƭ GetGroupTransactionsOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
transactionType Sale | Purchase | AffiliateSale | DevEx | GroupPayout | AdImpressionPayout

Defined in: client/apis/EconomyAPI.ts:131

GetResaleTaxRate

Ƭ GetResaleTaxRate: object

Type declaration:

Name Type
minimumFee number
taxRate number

Defined in: client/apis/EconomyAPI.ts:50

GetSelfCurrency

Ƭ GetSelfCurrency: object

Type declaration:

Name Type
robux number

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

GetSelfCurrencyOptions

Ƭ GetSelfCurrencyOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/EconomyAPI.ts:109

GetSelfRevenueSummaryInTimeFrame

Ƭ GetSelfRevenueSummaryInTimeFrame: GetGroupRevenueSummaryInTimeFrame

Defined in: client/apis/EconomyAPI.ts:130

GetSelfRevenueSummaryInTimeFrameOptions

Ƭ GetSelfRevenueSummaryInTimeFrameOptions: Omit<GetGroupRevenueSummaryInTimeFrameOptions, groupId> & { userId: number }

Defined in: client/apis/EconomyAPI.ts:127

GetSelfTransactions

Ƭ GetSelfTransactions: GetGroupTransactions

Defined in: client/apis/EconomyAPI.ts:158

GetSelfTransactionsOptions

Ƭ GetSelfTransactionsOptions: Omit<GetGroupTransactionsOptions, groupId> & { userId: number }

Defined in: client/apis/EconomyAPI.ts:155

GetUserResellableAssetCopies

Ƭ GetUserResellableAssetCopies: object

Type declaration:

Name Type
data GetAssetResellers[data]

Defined in: client/apis/EconomyAPI.ts:47

GetUserResellableAssetCopiesOptions

Ƭ GetUserResellableAssetCopiesOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/EconomyAPI.ts:43

SetAssetCopies

Ƭ SetAssetCopies: unknown

Defined in: client/apis/EconomyAPI.ts:59

SetAssetCopiesOptions

Ƭ SetAssetCopiesOptions: object

Type declaration:

Name Type
assetId number
price number
userAssetId number

Defined in: client/apis/EconomyAPI.ts:54

SubmitDeveloperExchange

Ƭ SubmitDeveloperExchange: object

Type declaration:

Name Type
cashOutAbility object
cashOutAbility.canCashOut boolean
cashOutAbility.hasCashedOutThisMonth boolean
cashOutAbility.hasVerifiedEmail boolean
cashOutAbility.isUserBlcakListed boolean
cashOutAbility.lastImbursementStatusIsValid boolean
cashOutAbility.meetsMinimumCashOutBalance boolean
cashOutAbility.meetsPremiumRequirement boolean
errors unknown
submitted boolean

Defined in: client/apis/EconomyAPI.ts:90

SubmitDeveloperExchangeOptions

Ƭ SubmitDeveloperExchangeOptions: SubmitDeveloperExchangeOptions

Defined in: client/apis/EconomyAPI.ts:89