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

Was this helpful?

  1. TECH
  2. API Documentation

Getting started

PreviousAPI DocumentationNextTest connectivity

Last updated 1 year ago

Was this helpful?

General API Information

Below we have mentioned the basic details that would help you setup your Dapp on top of Brine:

  • The base endpoint is:

  • All endpoints return either a JSON object or array.

  • All time and timestamp related fields are in milliseconds or default datetime format - β€œ%Y-%m-%d %H:%M:%S”

  • Kindly note that you need to create an account on Brine using your ETH wallet before using any of the APIs. Failure to do so might cause inconsistent API responses. This is an important step as this will help us create your username and Brine keys which are needed for accessing Brine’s APIs

πŸ”Œ
πŸ˜‹
https://api.brine.fi/