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

200
400
404

Content type

application/json

{"success": true,
"data": {"bids": [["46940.21",
"1.0215167337342548"
],
"46938.21",
"2.0215167337342548"
],
"asks": [["3.945454",
"5.5"
],
["6",
"14"
]
],
"time": 1648152088
}
}

GET SYMBOLS

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"data": [{"symbol": "ETH-USDT",
"name": "ETH-USDT",
"baseCurrency": "ETH",
"quoteCurrency": "USDT",
"enableTrading": true
},
{"symbol": "BTC-USDT",
"name": "BTC-USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"enableTrading": true
}
]
}

GET TICKER

query Parameters

symbol

string

Example: symbol=KLV-USDT

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"symbol": "KLV-USDT",
"baseVolume": "3307686.6511170827",
"basePrecision": "5",
"quotePrecision": "6",
"quoteVolume": "70079.9570772176311649",
"price": "0.021187",
"high": "0.02364",
"low": "0.020243",
"bid": "30000",
"ask": "40000",
"variationPrice": "0.0005500112230535",
"variationRatePrice": "2.6651718862585",
"time": 1648152241
}
}

GET TICKERS

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"data": [{"symbol": "ETH-USDT",
"baseVolume": "0.2427019187709352",
"basePrecision": "6",
"quotePrecision": "3",
"quoteVolume": "756.9109784351795504603144",
"price": "3118.685597",
"high": "3118.685597",
"low": "2889.716511425422",
"bid": "3118.685597",
"ask": "3118.685597",
"variationPrice": "204.67045514534476",
"variationRatePrice": "7.023657914662727",
"time": 1648152349
},
{"symbol": "BTC-USDT",
"baseVolume": "0.16900775",
"quoteVolume": "7474.78688297",
"price": "44227.48",
"high": "45052.92",
"low": "42062.02769541285",
"bid": "44227.48",
"ask": "44227.48",
"variationPrice": "2165.4523045871515",
"variationRatePrice": "5.148235649189372",
"time": 1648152349
}
]
}

Order

CREATE LIMIT ORDER

Authorizations:

ApiKeyAuth

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

Payload

Content type

application/json

{"side": "BUY",
"symbol": "DVK-KLV",
"quantity": 5,
"price": 0.000001
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"data": {"orderId": "bd4133ef-de2b-458d-881d-1a016a7738c0"
}
}

CREATE MARKET ORDER

Authorizations:

ApiKeyAuth

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

Payload

Content type

application/json

{"side": "BUY",
"symbol": "DVK-KLV",
"quantity": 2
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"data": {"orderId": "89639381-6ca9-45be-b68b-4287afa30120"
}
}

CANCEL ORDER

Authorizations:

ApiKeyAuth

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

200
400
401

Content type

application/json

{"success": true,
"data": {"orderId": "bd4133ef-de2b-458d-881d-1a016a7738c0"
}
}

GET ORDER STATUS BY ID

Authorizations:

ApiKeyAuth

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

200
401
404

Content type

application/json

{"success": true,
"data": {"orderId": "6725ce5a-af91-4dea-850b-09968fb551f8",
"status": "CANCELED",
"symbol": "KLV-USDT",
"side": "BUY",
"price": 0.00678,
"averagePrice": 0.006736,
"quantity": 100,
"filled": 80,
"typeOrder": "LIMIT",
"typeTrade": "MAKER",
"createdAt": 1708459934,
"updatedAt": 1708459952
}
}

GET OPEN ORDERS

query Parameters

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

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"orderId": "bcd3ec7a-806b-4194-88d2-dd11cd581b7e",
"status": "OPEN",
"symbol": "KLV-USDT",
"side": "SELL",
"price": 0.007647,
"averagePrice": null,
"quantity": 100,
"filled": 0,
"typeOrder": "LIMIT",
"typeTrade": "MAKER",
"createdAt": 1708460381,
"updatedAt": 1708460381
},
{"orderId": "338a6c5e-e4f6-47c4-a9a2-edec230787d5",
"status": "PARTIALLY",
"symbol": "KLV-USDT",
"side": "BUY",
"price": 0.06874,
"averagePrice": 0.06874,
"quantity": 100,
"filled": 40,
"typeOrder": "LIMIT",
"typeTrade": "MAKER",
"createdAt": 1708460362,
"updatedAt": 1708460362
}
]
}

GET HISTORY ORDERS

query Parameters

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

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"orderId": "bcd3ec7a-806b-4194-88d2-dd11cd581b7e",
"status": "CANCELED",
"symbol": "KLV-USDT",
"side": "SELL",
"price": 0.007647,
"averagePrice": null,
"quantity": 100,
"filled": 0,
"typeOrder": "LIMIT",
"typeTrade": "MAKER",
"createdAt": 1708460381,
"updatedAt": 1708460381
},
{"orderId": "338a6c5e-e4f6-47c4-a9a2-edec230787d5",
"status": "DONE",
"symbol": "KLV-USDT",
"side": "BUY",
"price": 0.06874,
"averagePrice": 0.06874,
"quantity": 100,
"filled": 100,
"typeOrder": "LIMIT",
"typeTrade": "MAKER",
"createdAt": 1708460362,
"updatedAt": 1708460362
}
]
}

Account

GET BALANCE

Authorizations:

ApiKeyAuth

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

200
400
404

Content type

application/json

{"success": true,
"data": {"currency": "KLV",
"balance": "5.197532003729595",
"available": "5.197532003729595",
"holds": "0"
}
}

ADD WITHDRAW

Authorizations:

ApiKeyAuth

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

Payload

Content type

application/json

{"currency": "KLV",
"address": "klv1lwv996lr5vq8p6r2gmwyxtj7567fc089y9q3dwu24l8l4g5k8husl8psu4",
"chain": "KLV",
"amount": 100.654
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"withdrawalId": 65987
}
}

GET WITHDRAWALS

Authorizations:

ApiKeyAuth

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

200
401
404

Content type

application/json

{"success": true,
"data": {"withdrawalId": 65987,
"amount": 99999,
"transactionFee": 100.55,
"confirmations": 6,
"txId": "624d5e2d436e8f48d1399898fd421ef18f115d9f8951bc2c4776981d29839c6c",
"currency": "KLV",
"address": "klv1lwv996lr5vq8p6r2gmwyxtj7567fc089y9q3dwu24l8l4g5k8husl8psu4",
"chain": "KLV",
"status": "PROGRESS",
"info": "",
"createdAt": 1550653727,
"updatedAt": 1671568425
}
}

Health

HEALTH

Responses

Response samples

200

Content type

application/json

{"response": "RUNNING"
}