Loopring Dev Docs
  • Introduction
  • Endpoints
  • SDK
    • SDK Guides
    • Test Mock Data
      • Mock Account
      • Mock provider
      • Mock ERC20 Token Map
      • Mock AMM MAP
      • Mock EIP712 Typed Data
      • Mock Generate eddsaKey
  • Glossary
  • 🗳️Loopring Account
    • Introduction
    • SDK Guides
      • Setup a Loopring Account
      • Unlock Account (Login)
    • API References
      • Get Account info
        • Sample code
      • Update EddsaKey
        • Sample code
      • Get apiKey
        • Sample code
      • Update apiKey
        • Sample code
  • 🎨CounterFactual NFT
    • Introduction
      • Compute NFT Address API
      • When to deploy counterfactual NFT contracts?
    • SDK Guides
      • Deposit NFT
      • Create Collection
      • Mint Counterfactual NFT
      • Transfer NFT
      • Deploy NFT
      • Withdraw NFT
      • Trade NFT
        • Validate NFT Order
      • Meta & IPFS
    • API References
      • NFT Collection
        • Create collection
          • Sample code
        • Edit collection
          • Sample code
        • Delete collection
          • Sample code
        • List owned collections
          • Sample code
        • List user's NFTs under one collection
          • Sample code
        • List user's NFT balances group by Collection ID
          • Sample code
        • List all NFTs of a collection
          • Sample code
        • Get collection by Collection ID
          • Sample code
        • Get collections by contract address
          • Sample code
      • Get NFT Assets
        • Sample code
      • Get NFT Balances
        • Sample code
      • Mint NFT
        • Sample code
      • Transfer NFT
        • Sample code
      • Validate NFT Order
        • Sample code
      • Trade NFT
        • Sample code
      • Deploy NFT TokenAddress
        • Sample code
      • Withdraw NFT
        • Sample code
      • Get NFT Transactions
        • Sample code
      • Get NFT Trade History
        • Sample code
      • Get AvailableBroker
        • Sample code
      • Get NFT Info
        • Sample code
      • Get NFT Data
        • Sample code
      • Get NFT Holders
        • Sample code
  • 🪙ERC20 Tokens
    • Introduction
    • SDK Guides
      • Transfer ERC20
      • Withdraw ERC20
      • Deposit ERC20
      • Order ERC20
    • API References
      • Get Assets
        • Sample code
      • Transfer
        • Sample code
      • Submit Order
        • Sample code
      • Cancel Order
        • Sample code
      • Withdraw
        • Sample code
      • Get Transactions
        • Sample code
      • Get Orders
        • Sample code
      • Get Trade History
        • Sample code
  • 🔬Resources
    • Advanced
      • UpdateAccount with custom seed
      • Pay payee updateAccount fee
      • Common error and solutions
      • Submit erc20 order
    • Common Info
      • Get relayer current time
        • Sample code
      • Get exchange info
        • Sample code
      • Get token info
        • Sample code
      • Get markets info
        • Sample code
    • Error codes
    • Fees
      • GET ERC20 Offchain Fee
        • Sample code
      • GET ERC20 Order Fee
        • Sample code
      • GET NFT Offchain Fee
        • Sample code
      • GET NFT Order Fee
        • Sample code
      • SDK Fees
    • Layer 2 block info
      • Get pending transactions
    • Request signing
      • Special API Request Signatures
      • Off-chain Request Signatures
      • Extra ECDSA authentic in header
    • Signature
      • ECDSA signature
        • ECDSA key generation
        • ECDSA sign
        • ECDSA verify signature
      • EdDSA signature
        • EdDSA key generation
        • EdDSA sign
        • EdDSA verify signature
      • SDK Signature
        • Mock Signature
    • Smart Contracts
    • Storage Id
      • Sample code
    • WebSocket
      • Account Notification
      • Order Notification
      • Orderbook Notification
      • Trade Notification
      • Ticker Notification
      • Candlestick Notification
      • AMM Pool Snapshot Notification
      • Block Generation Notification
    • Loopring Smart Wallet
      • Signature and verification
Powered by GitBook
On this page
  • EndPoint
  • Header
  • Request
  • Response
  • Model
  • CombinedBalance
  • PendingBalance

Was this helpful?

  1. CounterFactual NFT
  2. API References

Get NFT Assets

EndPoint

GET /api/v3/user/nft/balances

Header

Field
Description
Example

X-API-KEY

ApiKey, can use a valid apiKey to get other address asset

"HlkcGxbqBeaF76j4rvPaOasyfPwnkQ6B6DQ6THZWbvrAGxzEdulXQvOKLrRWZLnN"

Request

Field
Description
Example

accountId

(Optional) AccountID, accountId or address is required

1

address

(Optional) Address, accountId or address is required

"0x8656920c85342d646E5286Cb841F90209272ABeb"

nftDatas

(Optional) The Loopring's NFT token data identifier which is a hash string of NFT token address and NFT_ID, separated by ","

"0xf7c932351186c3a9053f313eefa16209c018f7f1dba8aa8ca7100400f7c31085,0xc3a9053f313eef7c932351ca7100400f7c186fa16209c018f7f 1dba8aa831085"

tokenAddrs

(Optional) NFT token address, separated by ","

"0x8656920c85342d646E5286Cb841F90209272ABeb,0x8656920c85342d646E5286Cb841F90209272ABec"

tokenIds

(Optional) The token slot ID in loopring DEX, separated by ","

"32768,32769,32770"

offset

(Optional) Number of records to skip

10

limit

(Optional) Number of records to return.

Default is 20, max is 50

30

nonZero

(Optional) Hide 0 balance NFT token, default is true

true

metadata

(Optional) Return the metadata of the nft

false

Response

Field
Description
Example

totalNum

total number

100

data

Model

CombinedBalance

Field
Description
Example

accountId

AccountID

10110

tokenId

tokenId

32768

nftData

(Optional) Users NFT token nftData

"0xf7c932351186c3a9053f313eefa16209c018f7f1dba8aa8ca7100400f7c31085"

tokenAddress

(Optional) token address

"0x8656920c85342d646E5286Cb841F90209272ABeb"

nftType

nft type

ERC1155 or ERC721

nftId

(Optional) nft id

"100"

total

total amount

"1000"

locked

frozen amount

"2"

pending

"{withdraw:0, deposit:0}"

isCounterFactualNFT

is counterFactual NFT or not

true

deploymentStatus

tokenAddress deploy status

status in NOT_DEPLOYED, DEPLOYING, DEPLOYED

PendingBalance

Field
Description
Example

withdraw

Withdrawal pending balance which means the token is in withdrawal state but not arrived L1

"100000000000 00"

deposit

Deposit pending balance which means the token is in deposit state but not arrived L2

"100000000000 00"

PreviousSample codeNextSample code

Last updated 1 year ago

Was this helpful?

List[]

🎨
Combined Balance
pending balance