Skip to main content

Bitcoin.me API (1.0.0)

Download OpenAPI specification:Download

Authentication

ApiKeyAuth

You must create an API key via the Bitcoin.me website to make private requests.

Security Scheme Type API Key
Header parameter name: apikey

Market

GET ORDERBOOK

query Parameters
limit
integer
Example: limit=10
symbol
string
Example: symbol=KLV-USDT

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

GET SYMBOLS

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

GET TICKER

query Parameters
symbol
string
Example: symbol=KLV-USDT

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

GET TICKERS

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Order

CREATE LIMIT ORDER

Authorizations:
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf
Request Body schema: application/json
side
string
symbol
string
quantity
number
price
number

Responses

Request samples

Content type
application/json
{
  • "side": "BUY",
  • "symbol": "DVK-KLV",
  • "quantity": 5,
  • "price": 0.000001
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

CREATE MARKET ORDER

Authorizations:
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf
Request Body schema: application/json
side
string
symbol
string
quantity
number

Responses

Request samples

Content type
application/json
{
  • "side": "BUY",
  • "symbol": "DVK-KLV",
  • "quantity": 2
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

CANCEL ORDER

Authorizations:
path Parameters
orderId
string
Example: bd4133ef-de2b-458d-881d-1a016a7738c0
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

GET ORDER STATUS BY ID

Authorizations:
path Parameters
orderId
string
Example: 6725ce5a-af91-4dea-850b-09968fb551f8
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

GET OPEN ORDERS

query Parameters
symbol
string
Example: symbol=KLV-USDT
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

GET HISTORY ORDERS

query Parameters
symbol
string
Example: symbol=KLV-USDT
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Account

GET BALANCE

Authorizations:
query Parameters
abbr
string
Example: abbr=KLV
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

ADD WITHDRAW

Authorizations:
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf
Request Body schema: application/json
currency
string
address
string
chain
string
amount
number

Responses

Request samples

Content type
application/json
{
  • "currency": "KLV",
  • "address": "klv1lwv996lr5vq8p6r2gmwyxtj7567fc089y9q3dwu24l8l4g5k8husl8psu4",
  • "chain": "KLV",
  • "amount": 100.654
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

GET WITHDRAWALS

Authorizations:
query Parameters
withdrawalId
integer
Example: withdrawalId=65987
currency
string
Example: currency=KLV
limit
integer
Example: limit=100
offset
integer
Example: offset=100
header Parameters
apikey
string
Example: cc446845-b830-416b-bd2a-32c0dfa5cc73-d190cb15-57f7-6b98-a129-fad09b3d2acf

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Health

HEALTH

Responses

Response samples

Content type
application/json
{
  • "response": "RUNNING"
}