Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rho Protocol User Data API

The User Data API from Rho Protocol — 12 operation(s) for user data.

Rho Protocol User Data API is one of 4 APIs that Rho Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include User Data. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

This API exposes 12 operations across 12 paths, and defines 24 schemas. It is described by OpenAPI 2.0, at version development.

Requests are made against the base URL https://x.rho.trading/api/v1.

12 operations 12 paths 24 schemas 11 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
development
Base URL
https://x.rho.trading/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rho Protocol User Data API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 11 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

User Data 12
GET
/margin-accounts
Retrieve all margin accounts for a user
→ 200400401403500
GET
/margin-accounts/{marginAccount}
Retrieve a single margin account
1 param → 200400401403500
GET
/margin-accounts/{marginAccount}/candles
Retrieve user margin account candles
5 params → 200400401403500
GET
/users/account
Retrieve total user account info
→ 200400401403500
GET
/users/account/candles
Retrieve user total account candles
4 params → 200400401403500
GET
/users/balances
Retrieve user balances
1 param → 200400401403500
GET
/users/balances/withdrawable
Retrieve user withdrawable balances
1 param → 200400401403500
GET
/users/orders
Retrieve user's orders.
1 param → 200400401403500
GET
/users/positions
Retrieve user's open positions.
1 param → 200400401403500
GET
/users/trades
Retrieve recent trades for a user
1 param → 200400401403500
GET
/users/transfers
Retrieve recent transfers for a user
1 param → 200400401403500
POST
/users/withdrawals
Request withdrawal
1 param → 202400401403500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are dto.UserAccountCandle (27 properties), dto.UserMarginAccountCandle (26 properties), dto.Position (23 properties), dto.Transfer (20 properties). Each schema is shown below with its type and property counts.

dto.MarginAccountSummary
object
14 properties
dto.UserTotalAccountSummary
object
11 properties
dto.UserTotalAccountResponse
object
1 property
dto.PositionMarginDetails
object
8 properties
dto.UserAccountCandlesResponse
object
1 property
dto.UserBalances
object
3 properties
dto.MarginAccount
object
17 properties
dto.UserMarginAccountCandle
object
26 properties
dto.RestWithdrawalRequest
object
8 properties 4 required
dto.Order
object
17 properties
dto.UserTradesResponse
object
1 property
dto.UserPositions
object
3 properties
dto.UserAccountCandle
object
27 properties
dto.UserOrders
object
2 properties
dto.WithdrawableBalance
object
6 properties
dto.UserMarginAccountCandlesResponse
object
1 property
dto.UserTrade
object
15 properties
dto.Position
object
23 properties
dto.CurrencyBalance
object
4 properties
dto.ExternalError
object
5 properties
dto.Transfer
object
20 properties
dto.UserWithdrawableBalances
object
2 properties
dto.UserTransfersResponse
object
1 property
dto.MarginAccountsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rho-protocol-user-data-api-openapi.yml Raw ↑

Other APIs Rho Protocol publishes across the network.

Rho Protocol Market Data API
Rho Protocol Stats API
Rho Protocol Trading API