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
  1. Spot

Account

PreviousTradeNextFutures

Last updated 17 days ago

  • GETAccount Information
  • POSTTransfer
  • POSTTransfer Record Query

Account Information

get

Retrieve account balances.

Header parameters
X-CH-APIKEYstringRequired
X-CH-TSstringRequired
X-CH-SIGNstringRequired
Responses
200
Successfully retrieved account information.
application/json
get
GET /sapi/v1/account HTTP/1.1
Host: openapi.coinlocally.com
X-CH-APIKEY: text
X-CH-TS: text
X-CH-SIGN: text
Accept: */*
200

Successfully retrieved account information.

{
  "balances": [
    {
      "asset": "BTC",
      "free": "0",
      "locked": "0"
    },
    {
      "asset": "ETH",
      "free": "0",
      "locked": "0"
    }
  ]
}

Transfer

post

Transfer assets between accounts.

Header parameters
X-CH-APIKEYstringRequired
X-CH-TSstringRequired
X-CH-SIGNstringRequired
Body
coinSymbolstringRequired
amountstringRequired
fromAccountstringRequired
toAccountstringRequired
Responses
200
Transfer successful
application/json
post
POST /sapi/v1/asset/transfer HTTP/1.1
Host: openapi.coinlocally.com
X-CH-APIKEY: text
X-CH-TS: text
X-CH-SIGN: text
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "coinSymbol": "text",
  "amount": "text",
  "fromAccount": "text",
  "toAccount": "text"
}
200

Transfer successful

{
  "code": "0",
  "msg": "SUCCESS",
  "data": {
    "transferId": "1a9ec387-8b81-4789-a98e-bc6a606c8736"
  }
}

Transfer Record Query

post

Query records of transfers.

Header parameters
X-CH-APIKEYstringRequired
X-CH-TSstringRequired
X-CH-SIGNstringRequired
Body
transferIdstringOptional
coinSymbolstringOptional
fromAccountstringOptional
toAccountstringOptional
startTimeintegerOptional
endTimeintegerOptional
pageintegerOptional
limitintegerOptional
Responses
200
Query successful
application/json
post
POST /sapi/v1/asset/transferQuery HTTP/1.1
Host: openapi.coinlocally.com
X-CH-APIKEY: text
X-CH-TS: text
X-CH-SIGN: text
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "transferId": "text",
  "coinSymbol": "text",
  "fromAccount": "text",
  "toAccount": "text",
  "startTime": 1,
  "endTime": 1,
  "page": 1,
  "limit": 1
}
200

Query successful

{
  "code": "0",
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "transferId": "1a9ec387-8b81-4789-a98e-bc6a606c8736",
        "fromAccount": "EXCHANGE",
        "toAccount": "FUTURE",
        "coinSymbol": "USDT",
        "createTime": 1742369830000,
        "amount": "1",
        "status": "SUCCESS"
      }
    ]
  }
}