Coinlocally Docs
API Document
API Document
  • Introduction
    • API Basic Information
    • HTTP Error Codes
    • General Information
    • Limits
    • Endpoint Security Type
    • Signature Authentication
    • Timing Security
    • SIGNED Endpoint Example
  • Changelog
  • Spot
    • Public
    • Market
    • Trade
    • Account
  • Futures
    • Public
    • Market
    • Trade
    • Account
  • Margin
  • Withdraw
  • WebSocket
    • Spot
    • Futures
  • Official SDK
  • Enums
  • Error
  • FAQ
Powered by GitBook
On this page

Margin

PreviousAccountNextWithdraw

Last updated 17 days ago

Current Open Margin Orders

get

Retrieve current open margin orders.

Rate Limit: 20 requests per 2 seconds

Weight: 1 (IP/UID)

Query parameters
symbolstringOptional
limitstringOptional
Header parameters
X-CH-SIGNstringRequired
X-CH-TSstringRequired
X-CH-APIKEYstringRequired
Responses
200
Successfully retrieved open orders
application/json
get
GET /sapi/v2/margin/openOrders HTTP/1.1
Host: openapi.coinlocally.com
X-CH-SIGN: text
X-CH-TS: text
X-CH-APIKEY: text
Accept: */*
200

Successfully retrieved open orders

[
  {
    "orderId": "499902955766523648",
    "symbol": "BHTUSDT",
    "price": "0.01",
    "origQty": "50",
    "executedQty": "0",
    "avgPrice": "0",
    "status": "NEW",
    "type": "LIMIT",
    "side": "BUY",
    "time": "1574329076202"
  }
]

Trade History

get

Fetch margin trade history.

Weight: 1 (IP/UID)

Query parameters
symbolstringOptional
limitstringOptional
fromIdstringOptional
Header parameters
X-CH-SIGNstringRequired
X-CH-TSstringRequired
X-CH-APIKEYstringRequired
Responses
200
Successfully retrieved trade history
application/json
get
GET /sapi/v2/margin/myTrades HTTP/1.1
Host: openapi.coinlocally.com
X-CH-SIGN: text
X-CH-TS: text
X-CH-APIKEY: text
Accept: */*
200

Successfully retrieved trade history

[
  {
    "symbol": "ETHBTC",
    "id": 100211,
    "bidId": 150695552109032480,
    "askId": 150695552109032480,
    "price": "4.00000100",
    "qty": "12.00000000",
    "time": 1499865549590,
    "isBuyer": true,
    "isMaker": false,
    "feeCoin": "ETH",
    "fee": "0.001"
  }
]
  • POSTNew Margin Order
  • GETQuery Margin Order
  • POSTCancel Margin Order
  • GETCurrent Open Margin Orders
  • GETTrade History

Query Margin Order

get

Query existing margin order details.

Rate Limit: 20 requests per 2 seconds

Weight: 5 (IP/UID)

Query parameters
orderIdstringOptional
newClientOrderIdstringOptional
symbolstringOptional
Header parameters
X-CH-SIGNstringRequired
X-CH-TSstringRequired
X-CH-APIKEYstringRequired
Responses
200
Order query successful
application/json
get
GET /sapi/v2/margin/order HTTP/1.1
Host: openapi.coinlocally.com
X-CH-SIGN: text
X-CH-TS: text
X-CH-APIKEY: text
Accept: */*
200

Order query successful

{
  "orderId": "499890200602846976",
  "clientOrderId": "157432755564968",
  "symbol": "BHTUSDT",
  "price": "0.01",
  "origQty": "50",
  "executedQty": "0",
  "avgPrice": "0",
  "status": "NEW",
  "type": "LIMIT",
  "side": "BUY",
  "transactTime": "1574327555669"
}

New Margin Order

post

Place a new margin order.

Rate Limit: 100 requests per 2 seconds

Weight: 5 (IP/UID)

Header parameters
X-CH-SIGNstringRequired
X-CH-TSstringRequired
X-CH-APIKEYstringRequired
Body
typestringRequiredExample: LIMIT
recwwindowstringOptionalExample: 5000
pricenumberRequiredExample: 9500.5
newClientOrderIdstringOptionalExample: customId123
sidestringRequiredExample: BUY
volumenumberRequiredExample: 1.5
symbolstringRequiredExample: BTCUSDT
Responses
200
Order successfully placed
application/json
post
POST /sapi/v2/margin/order HTTP/1.1
Host: openapi.coinlocally.com
X-CH-SIGN: text
X-CH-TS: text
X-CH-APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "type": "LIMIT",
  "recwwindow": "5000",
  "price": 9500.5,
  "newClientOrderId": "customId123",
  "side": "BUY",
  "volume": 1.5,
  "symbol": "BTCUSDT"
}
200

Order successfully placed

{
  "symbol": "LXTUSDT",
  "orderId": "494736827050147840",
  "clientOrderId": "157371322565051",
  "transactTime": "1573713225668",
  "price": "0.005452",
  "origQty": "110",
  "executedQty": "0",
  "status": "NEW",
  "type": "LIMIT",
  "side": "SELL"
}

Cancel Margin Order

post

Cancel an existing margin order.

Rate Limit: 100 requests per 2 seconds

Weight: 5 (IP/UID)

Header parameters
X-CH-SIGNstringRequired
X-CH-TSstringRequired
X-CH-APIKEYstringRequired
Body
orderIdstringOptionalExample: 499890200602846976
symbolstringOptionalExample: BTCUSDT
newClientOrderIdstringOptionalExample: customOrderId
Responses
200
Order canceled successfully
application/json
post
POST /sapi/v2/margin/cancel HTTP/1.1
Host: openapi.coinlocally.com
X-CH-SIGN: text
X-CH-TS: text
X-CH-APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "orderId": "499890200602846976",
  "symbol": "BTCUSDT",
  "newClientOrderId": "customOrderId"
}
200

Order canceled successfully

{
  "symbol": "BHTUSDT",
  "clientOrderId": "0",
  "orderId": "499890200602846976",
  "status": "CANCELED"
}