Brine's Docupaper
AboutTrade
  • ABOUT
    • πŸ“’Brine Docupaper
    • πŸͺ™Tokenomics
  • πŸ—žοΈBrine Bytes
    • 🧡October Edition
  • TECH
    • πŸ‘©β€πŸ’»Tech Docupaper
      • 🏨High level architecture
      • πŸ€”Starkware logic
      • 🌊Transactional flow
        • Off-chain accounts
        • The deposit flow
        • The withdrawal flow
        • The trade flow
        • The transfer flow
        • Full withdrawal
    • πŸ”ŒAPI Documentation
      • πŸ˜‹Getting started
        • Test connectivity
      • πŸ“ˆMarket
        • 24hr Tickers Price
        • K-line/Candlestick data
        • Orderbook
        • Recent trades
      • ↔️Trading
        • Create order
        • Get order
        • List orders
        • Cancel order
        • List trades
      • πŸ”Account
        • Login
        • Profile Information
        • Balance details
        • Profit and loss details
      • 🌏Web-socket stream
        • πŸ—οΈPrivate web-socket connection
        • πŸ‘₯Public websocket connection
      • ✨Internal Transfer
        • Create Internal Transfer
        • Get Internal Transfer
        • Check User Existence
        • List Internal Transfers
      • πŸ§ͺSDK Reference
        • NodeJS SDK
  • FOR USERS
    • πŸ“’User Docuguide
      • πŸ’»Web App
        • Sign up through Metamask
        • Sign up through Wallet Connect
        • Place a Market Order Trade
        • Place a Limit Order Trade
        • Refer Brine to a Friend
        • Deposit with Metamask
        • Withdraw to Metamask
  • LEGAL
    • ‼️Disclaimer
Powered by GitBook
On this page
  • Endpoint
  • Request Headers
  • Query Params

Was this helpful?

  1. TECH
  2. API Documentation
  3. Account

Balance details

Get your balance details.

Retrieve details of a specific user’s balance. Please note that this is a Private πŸ”’ route which means it needs to be authorized by the account initiating this request.

Note: You will need to include the JWT Auth token to request headers to access this endpoint. To get the JWT Auth Token, refer the login section of the documentation.

Endpoint

GET /sapi/v1/user/balance/

Request Headers

{
  "Authorization": "JWT ***"
}

Query Params

Field
Type
Mandatory
Description

currency

STRING

NO

If the currency parameter is not specified, the whole list of balances will be returned.

Example

{baseurl}/sapi/v1/user/balance/?currency=eth

Response

{
  "status": "success",
  "message": "Retrieved Successfully",
  "payload": {
    "currency": "eth",
    "balance": "0.1959644",
    "locked": "0.0",
    "deposit_address": null
  }
}
PreviousProfile InformationNextProfit and loss details

Last updated 2 years ago

Was this helpful?

πŸ”Œ
πŸ”