LayerAkira documentation
  • about
    • Overview
    • Trading pairs
    • Fees
    • Glossary
    • FAQ
  • integration
    • Technical Overview
      • Fee types
      • Exchange flow
      • Trading pipeline
      • Trading accounts
      • Ecosystem Book
        • Direct user interactions
      • Router Book
      • Routers
        • Rewards and penalties
        • Router flow
      • Signature
    • Trading
      • Fees
      • Order
        • Order structure
        • Order status
        • Self trade prevention modes (STP modes)
        • Execution semantic
      • Deposit
      • Withdraw
      • Increase Nonce
      • Matching engine status
    • Endpoints
      • Common
      • Auth
      • Get endpoints
      • Post endpoints
      • Responses
      • Stream subscriptions
      • Withdraw money
      • Increase nonce
    • Smart Contact
      • Methods
      • Structures
      • Events
    • SDK
      • Python CLI
    • Testnet
  • Legal
    • Terms of Service
Powered by GitBook
On this page
  • Best Bid and Offer
  • Snapshot
  • User info
  • Listen key
  • Gas oracle
  • Get sign data
  • Conversion rate
  • Steps specification
  • Layerakira router specification
  • Ticker specification
  • Get order
  • Get orders
  1. integration
  2. Endpoints

Get endpoints

PreviousAuthNextPost endpoints

Last updated 4 months ago

Best Bid and Offer

GET /book/bbo?base=<symbol>&quote=<symbol>&to_ecosystem_book=<1|0>

Returns the best level bids and asks for the requested pair of tokens' depthbook

Snapshot

GET /book/snapshot?levels=<num_lvls>&base=<symbol>&quote=<symbol>&to_ecosystem_book=<1|0>

Returns order book with specified amount of levels for requested trading pair. If levels set as -1 all levels will be returned

User info

GET /user/user_info?trading_account=0x123

Returns user information regarding nonce, balances and fee levels

Listen key

GET /user/listen_key

Returns for an authorised user and used as prolongation of current listen key.

Gas oracle

GET /gas/price

Returns the current minimum amount of gas price that is necessary to be specified in order to perform any gas-involved trading activity.

User can periodically query this amount and use it to build a GasFee entity skewed on some small multiplier.

Get sign data

GET /sign/request_sign_data?user=<signer>&account=<trading_account>

For router users who trade via external funds, the exchange will validate signature via account abstraction so 'user' query param can be of same value as account.

Conversion rate

GET /info/conversion_rate?token=<symbol>

If user want to use paymasters (pay for gas not in strk) he needs to specify conversion rate. Exchange provides convenient method to query it. Client also can track it by taking mid bid/ask.

Steps specification

GET /info/steps_specification

Each user action that require onchain fingerprint consumes some amount of gas steps. We provide expected upper bound for these trades (they are constant within chain(mainnet/sepolia). However, actual gas expenditure will likely be less as we bundle actions into a rollup. Mainly we have the following actions:

  1. offchain withdrawal

  2. offchain increase nonce

  3. ecosystem trade

  4. router trade

Layerakira router specification

GET /info/router_details

Ticker specification

GET /info/ticker_specifications

Each trading pair have specific rules about trading amount, ticks and etc. This endpoint allows you to query these rules. Any changes will be announced in advance

Get order

GET /book/order?trading_account=0x123&order_hash=0x321&mode=1

Returns information about requested order

Get orders

GET /book/orders?trading_account=0x123&mode=1&offset=0&limit=20

Return all user's current orders, orders are sorted w.r.t. to created time of order field

Retrieves data that the client needs to sign via the private key of the to show that they are the real owner of the account.

If user trades over the LayerAkira frontend or , user needs to specify router details

listen_key
signer
leverages the LayerAkira Router