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

Qfex user API

The user API from Qfex — 15 operation(s) for user.

Qfex user API is one of 5 APIs that Qfex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include user. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 16 operations across 15 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.qfex.com.

16 operations 15 paths 26 schemas 13 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.qfex.com
Authentication
API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Qfex user API declares 4 security schemes for authenticating requests. An API key is passed in the header as x-qfex-hmac-signature (HMACSignature). An API key is passed in the header as x-qfex-nonce (Nonce). An API key is passed in the header as x-qfex-public-key (PublicKey). An API key is passed in the header as x-qfex-timestamp (Timestamp).

  • HMACSignature — HMAC-SHA256 signature (hex-encoded).
  • Nonce — Unique request nonce (hex encoded, max 100 characters).
  • PublicKey — QFEX API Authentication requires these headers: - x-qfex-public-key: Your public API key - x-qfex-hmac-signature: HMAC signature of the request (hex encoded) -…
  • Timestamp — Unix timestamp (seconds since epoch).

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 13 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

user 16
GET
/historic-orders-csv
Stream Historic Orders CSV
read-historic-orders-csv → 200default
GET
/historic-twaps-csv
Stream Historic TWAPs CSV
read-historic-twaps-csv 1 param → 200default
GET
/trades-csv
Stream Trades CSV
read-trades-csv → 200default
GET
/user/account-equity
Account Equity
read-account-equity 1 param → 200default
GET
/user/fees
User Fees
read-user-fees → 200default
GET
/user/historic-orders
Historic Orders
read-historic-orders 6 params → 200default
GET
/user/historic-pnl
Historic User PnL
read-historic-user-pnl 3 params → 200default
GET
/user/historic-twaps
Historic TWAPs
read-historic-twaps 2 params → 200default
POST
/user/leverage
Set User Leverage
set-user-leverage body → 200default
GET
/user/positions
User Positions
read-user-positions → 200default
GET
/user/referral-rewards
User Referral Rewards
read-user-referral-rewards 1 param → 200default
GET
/user/subaccounts
List Subaccounts
list-subaccounts → 200default
POST
/user/subaccounts
Create Subaccount
create-subaccount → 200default
GET
/user/trade
User Trades
read-user-trades 10 params → 200default
POST
/user/transfer
Transfer Balance
transfer-balance 2 params body → 204default
GET
/user/volume
User Volume
read-user-volume 2 params → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are HistoricOrder (16 properties), HistoricTwap (14 properties), Trade (12 properties), UserVolumeResponseBody (11 properties). Each schema is shown below with its type and property counts.

PositionPublic
object
11 properties 11 required
Trade
object
12 properties 12 required
ListSubaccountsResponseBody
object
2 properties 1 required
ReferralRewardsResponseBody
object
8 properties 6 required
HistoricUserPnlResponseBody
object
9 properties 6 required
AccountEquityPoint
object
2 properties 2 required
HistoricOrder
object
16 properties 16 required
ErrorDetail
object
3 properties
UserVolumePoint
object
4 properties 4 required
AccountEquityResponseBody
object
7 properties 5 required
HistoricUserPnlPoint
object
2 properties 2 required
CreateSubaccountResponseBody
object
2 properties 1 required
SetUserLeverageRequestBody
object
3 properties 2 required
TransferRequestBody
object
2 properties 1 required
ReferralReward
object
2 properties 2 required
PositionsBalanceResponseBody
object
3 properties 2 required
SetUserLeverageResponseBody
object
2 properties 1 required
BalancePublic
object
7 properties 7 required
HistoricTwapsResponseBody
object
3 properties 2 required
HistoricOrdersResponseBody
object
3 properties 2 required
UserVolumeResponseBody
object
11 properties 8 required
TradesResponseBody
object
3 properties 2 required
ErrorModel
object
7 properties
FeesResponseBody
object
2 properties 1 required
FeeEntry
object
2 properties 2 required
HistoricTwap
object
14 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qfex-user-api-openapi.yml Raw ↑

Other APIs Qfex publishes across the network.

QFEX Market Data WebSocket (MDS)
QFEX Trade WebSocket
Qfex market-data API
Qfex pnl API