ShapeBTC — Simple Crypto Exchange at the Best Price

API

This describes the resources that make up (partially) the official shapebtc.com API v1. If you have any problems or requests, please contact support.

All API access is over HTTPS and is accessed from https://shapebtc.com/api/v1.

The submitted data must be in JSON format with UTF-8 encoding. For successful API requests, all requests must contain several required headers:

 

  • The Content-Type header must be application/json; charset=UTF-8
  • The X-API-KEY header must contain your received API Key (YOUR_API_KEY)

cURL -X GET \
-H "Accept: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json; charset=UTF-8" \
-d 'DATA_JSON'
"https://shapebtc.com/api/METHOD"

/v1/price
A successful response contains information about exchange rate for the selected pair.

 

Server URL

https://shapebtc.com/api/v1/price
RESPONSE SAMPLES

{

  • "rate": 42010.12,
  • "withdrawalFee": "1 USDTTRC20",
  • "result": true

}

{

  • "status": 401,
  • "message": "Unauthorized"

}

PARAMETERS
fromCcy
string Example: "BTC" Code of the currency the client wants to send
toCcy
string Example: "USDTTRC20" Code of the currency the client wants to receive
amount
number Example: 1 The amount in currency fromCcy that the client wants to send
type
string Example: "float" Valid values: "float" "fixed" Order type
Responses
rate
float
withdrawalFee
float
result
bool
status
integer
message
string Required
RESPONSE SAMPLES

{

  • "BTC": {
    • "coinName": "Bitcoin",
    • "minamount": 0.01,
    • "maxamount": 101,
    • "tagname": "",
    • "network": "Bitcoin",
    • "available": true
    },
  • "ETH": {
    • "coinName": "Ethereum",
    • "minamount": 0.9,
    • "maxamount": 1702,
    • "tagname": "",
    • "network": "erc20",
    • "available": true
    }

}

{

  • "status": 401,
  • "message": "Unauthorized"

}

Responses
status
integer
message
string Required

Available pairs for exchange.

RESPONSE SAMPLES

{

  • "BTC": [
    • "ETH",
    • "USDTTRC20",
    • "XMR"
    ],
  • "USDTTRC20": [
    • "BTC",
    • "XMR",
    • "TRX",
    • "ETH"
    ]

}

{

  • "status": 401,
  • "message": "Unauthorized"

}

Responses
status
integer
message
string Required

Creating an order for the exchange of selected currencies with a specified amount and address.

RESPONSE SAMPLES

{

  • "id": "khvu65c1f334e621f",
  • "depositAddress": "bc1qjnyas2ndcyxrf932k1mpm49pyrtuytgd2zwlw8",
  • "depositTag": "",
  • "result": "true"

}

{

  • "status": 401,
  • "message": "Unauthorized"

}

PARAMETERS
fromCcy
string Example: "BTC" Code of the currency the client wants to send
toCcy
string Example: "USDTTRC20" Code of the currency the client wants to receive
amount
number Example: 1 The amount in currency fromCcy that the client wants to send
type
string Example: "float" Valid values: "float" "fixed" Order type
toAddress
string Example: "TNPdqto8HiuMzoG7Vv9wyyYhWzCojLeHAF" Destination address to which the funds will be sent upon successful completion of the order.
Responses
id
string Order ID
depositAddress
string The destination address to which the user is ought to deposit his funds in order for the trade to execute
depositTag
number MEMO or Destination Tag if required
result
boolean
status
integer
message
string Required

Get order details

RESPONSE SAMPLES

{

  • "status": "deposit_received",
  • "fromCcy": "BTC",
  • "toCcy": "USDTTRC20",
  • "depositAddress": "bc1qjnyas2ndcyxrf932k1mpm49pyrtuytgd2zwlw8",
  • "depositTag": "",
  • "destinationAddress": "TNPdqto8HiuMzoG7Vv9wyyYhWzCojLeHAF",
  • "destinationTag": "",
  • "expectedAmountFrom": "1",
  • "expectedAmountTo": "42020.15",
  • "amountFrom": "0.5",
  • "date": "01.01.2024 10:15:03",
  • "txId": null,
  • "amountTo": null,
  • "result": true

}

{

  • "status": 401,
  • "message": "Unauthorized"

}

PARAMETERS
id
string Order ID
Responses
status
string Order status. Can be one of the values:
  • new — new exchange
  • waiting_deposit — waiting for the deposit
  • deposit_received — deposit is received
  • exchanging — in the process of exchange
  • sending — in the process of sending
  • success — exchange completed successfully
  • time_expired — the waiting time for funds has expired
  • failed — the exchange ended with an error
  • sending_failed — sending attempt failed
  • reverted — the funds were returned to the client
fromCcy
string
toCcy
string
depositAddress
string The destination address to which the user is ought to deposit his funds in order for the trade to execute
depositTag
string MEMO or Destination Tag if required
destinationAddress
string The destination address to which the funds will be dispatched upon the successful completion of the order
destinationTag
string MEMO or Destination Tag if required
expectedAmountFrom
number
expectedAmountTo
number
amountFrom
number
amountTo
< anything >
date
string
txId
string
result
boolean
status
integer
message
string Required