Information

Exchange metadata, markets, and configuration

Health check

get

https://api.margin.tradehttp://localhost:8080

/health

Check API server health status

Responses

200

Server is healthy

text/plain

ResponsestringExample: ok

get

/health

HTTPcURLJavaScriptPython

GET /health HTTP/1.1
Host: api.margin.trade
Accept: */*

200

Server is healthy

ok

Get API version

get

https://api.margin.tradehttp://localhost:8080

/version

Returns current API version and build information

Responses

200

Version information

application/json

get

/version

HTTPcURLJavaScriptPython

GET /version HTTP/1.1
Host: api.margin.trade
Accept: */*

200

Version information

{
  "version": "1.0.0",
  "gitCommit": "a1b2c3d",
  "buildTime": "2024-01-20T10:00:00Z"
}

Get server time

get

https://api.margin.tradehttp://localhost:8080

/api/time

Returns current server timestamp in milliseconds

Responses

200

Server time

application/json

get

/api/time

HTTPcURLJavaScriptPython

GET /api/time HTTP/1.1
Host: api.margin.trade
Accept: */*

200

Server time

{
  "time": 1705790400000
}

Get exchange information

post

https://api.margin.tradehttp://localhost:8080

/info

Versatile endpoint for fetching various exchange information based on request type

Body

application/json

typestring · enumRequired

Request type

Possible values:

userstringOptional

User address (required for user-specific queries)

Example: 0x1234567890abcdef1234567890abcdef12345678

coinstringOptional

Market symbol

Example: BTC

dexstringOptional

DEX name or market filter

startTimeinteger · int64Optional

Start timestamp in milliseconds

endTimeinteger · int64Optional

End timestamp in milliseconds

oidinteger · int64Optional

Order ID

mantissaintegerOptional

Order book depth

nSigFigsintegerOptional

Number of significant figures for price aggregation

Responses

200

Requested information

application/json

Responseone of

or

or

post

/info

HTTPcURLJavaScriptPython

POST /info HTTP/1.1
Host: api.margin.trade
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "type": "allMids",
  "user": "0x1234567890abcdef1234567890abcdef12345678",
  "coin": "BTC",
  "dex": "text",
  "startTime": 1,
  "endTime": 1,
  "oid": 1,
  "mantissa": 1,
  "nSigFigs": 1,
  "req": {
    "coin": "text",
    "interval": "1h",
    "startTime": 1,
    "endTime": 1
  }
}

200

Requested information

{
  "universe": [
    {
      "name": "BTC",
      "szDecimals": 8,
      "maxLeverage": 50,
      "category": "crypto"
    }
  ],
  "marginTables": [
    []
  ]
}