Skip to main content
For authentication, error codes, pagination, and common types, refer to the MSU OpenAPI Builder Guide.

GetNeso — Get NESO Balance

GET /v1rc1/accounts/{walletAddress}/neso
Returns the on-chain and off-chain NESO balance of a wallet. Path Parameters
ParameterTypeDescription
walletAddressstringWallet address to query
Response data
FieldTypeDescription
offchainNesostringOff-chain (in-game) NESO balance
onchainNesostringOn-chain (blockchain) NESO balance
Common Errors
codeDescription
3walletAddress does not exist

ListCurrency — List Currencies

GET /v1rc1/accounts/{walletAddress}/currencies
Returns the list of internally defined currencies and their balances linked to the wallet. Path Parameters
ParameterTypeDescription
walletAddressstringWallet address to query
Response data
FieldTypeDescription
currencyCurrency[]List of currencies
Currency Object
FieldTypeDescription
codestringCurrency code
namestringCurrency name
amountstringBalance

ListCollection — List Collection

GET /v1rc1/accounts/{walletAddress}/collection
Returns the list of NFT assets (collection) held by the wallet. Uses scroll pagination with a maximum of 200 items per page. Path Parameters
ParameterTypeDescription
walletAddressstringWallet address to query
Query Parameters
ParameterTypeDescription
paginationParam.lastKeystringScroll cursor (omit on first request)
paginationParam.pageSizeintegerPage size (1–200, default 10)
Response data
FieldTypeDescription
collectionCollectionElement[]List of collection items
paginationResult.totalCountintegerTotal count
paginationResult.pageSizeintegerPage size
paginationResult.lastKeystringNext page cursor
paginationResult.isLastPagebooleanWhether this is the last page
CollectionElement Object
FieldTypeDescription
assetKeystringInternal asset identifier
tokenIdstringNFT token ID (empty if not minted)
itemIdintegerItem meta ID
mintingNointegerMinting number

ListWalletItems — List Wallet Items

GET /v1rc1/accounts/{walletAddress}/items
Returns the list of items held by the wallet. Uses cursor pagination with a fixed page size of 10. Path Parameters
ParameterTypeDescription
walletAddressstringWallet address to query
Query Parameters (optional)
ParameterTypeDescription
cursorstringCursor (omit on first request)
categoryNointegerFilter by item category number
isOnSalebooleanFilter to items currently on sale only
tokenNamestringSearch by item name (partial match)
tokenIdstringFilter by specific token ID
Response data
FieldTypeDescription
elementsNftItemElement[]List of items
nextCursorstringNext page cursor
hasMorebooleanWhether there is a next page
NftItemElement Object
FieldTypeDescription
assetKeystringInternal asset identifier
tokenTypeTokenTypeToken type (NFT_ITEM, FT_ITEM, etc.)
categoryCategoryCategory information
owner.walletAddressstringOwner’s wallet address
nftItem.itemNamestringItem name
nftItem.itemIdintegerItem meta ID
nftItem.starforceintegerStarforce enhancement level
nftItem.potentialGradeintegerPotential grade
nftItem.bonusPotentialGradeintegerAdditional potential grade
nftItem.enableStarforcebooleanWhether Starforce enhancement is available
nftItem.maxStarforceintegerMaximum Starforce level
nftItem.enablePotentialbooleanWhether Potential can be set
nftItem.enableExtraOptionbooleanWhether extra option can be set
nftItem.isMintedbooleanWhether minted
nftItem.tokenIdstringNFT token ID
nftItem.mintingNointegerMinting number
nftItem.isSbtbooleanWhether SBT (Soul Bound Token)
nftItem.locationLocationItem location
nftItem.usageStatusItemUsageStatusItem usage status
nftItem.imageUrlstringItem image URL
updatedAtstring (ISO8601)Last updated time
createdAtstring (ISO8601)Creation time
ItemUsageStatus Values
ValueDescription
ItemUsageStatus_Unknown (0)Unknown
ItemUsageStatus_Tradable (1)Tradable
ItemUsageStatus_OnSale (2)On sale
ItemUsageStatus_InGameUse (3)In use in-game
ItemUsageStatus_Burned (4)Burned
ItemUsageStatus_Abandoned (5)Abandoned (moved to trash wallet)
ItemUsageStatus_SBT (6)SBT
ItemUsageStatus_InGameExchangeShop (7)Held in in-game exchange shop
ItemUsageStatus_CollectionRegistered (8)Registered in collection
ItemUsageStatus_FusionDeposited (9)Deposited in Fusion basket
ItemUsageStatus_Enhancing (10)Under enhancement
Location Values (nftItem.location — for items in character inventory)
ValueDescription
Location_Anywhere (0)Any location
Location_WalletInventory (1)Wallet inventory
Location_CharacterInventory (2)Character inventory
Location_Etc (3)Other

ListCharacters — List Characters

GET /v1rc1/accounts/{walletAddress}/characters
Returns the list of characters linked to the wallet address. Uses cursor pagination with a fixed page size of 10. Path Parameters
ParameterTypeDescription
walletAddressstringWallet address to query
Query Parameters (optional)
ParameterTypeDescription
cursorstringCursor (omit on first request)
isTradablebooleanFilter to tradable characters only
Response data
FieldTypeDescription
charactersCharacterElement[]List of characters
nextCursorstringNext page cursor
hasMorebooleanWhether there is a next page
CharacterElement Object
FieldTypeDescription
namestringCharacter name
assetKeystringInternal character identifier
tokenIdstringNFT token ID (null if not minted)
categoryNointegerCategory number
data.classCodeintegerClass code
data.jobCodeintegerJob code
data.levelintegerLevel
data.worldintegerWorld code
data.exprstringExperience percentage
data.imageUrlstringCharacter image URL
data.combatPowerinteger (int64)Combat power