curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parentOrderId": "<string>",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderSide": "SELL",
"clientOrderId": "<string>",
"reference": "<string>"
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer"
payload = {
"parentOrderId": "<string>",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderSide": "SELL",
"clientOrderId": "<string>",
"reference": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentOrderId: '<string>',
baseSymbol: '<string>',
quoteSymbol: '<string>',
amount: {asset: '<string>', value: '<string>'},
price: {asset: '<string>', value: '<string>'},
orderSide: 'SELL',
clientOrderId: '<string>',
reference: '<string>'
})
};
fetch('https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parentOrderId' => '<string>',
'baseSymbol' => '<string>',
'quoteSymbol' => '<string>',
'amount' => [
'asset' => '<string>',
'value' => '<string>'
],
'price' => [
'asset' => '<string>',
'value' => '<string>'
],
'orderSide' => 'SELL',
'clientOrderId' => '<string>',
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer"
payload := strings.NewReader("{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"orderId": "BUY-12",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"pair": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderType": "OFFER",
"orderSide": "BUY",
"status": "OPEN",
"meta": {
"timestamps": {
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"filledAt": "2023-11-07T05:31:56Z"
},
"amounts": {
"filled": {
"asset": "<string>",
"value": "<string>"
},
"remaining": {
"asset": "<string>",
"value": "<string>"
}
},
"logs": [
{
"status": "<string>",
"at": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
]
},
"parentOrderId": "<string>",
"clientOrderId": "<string>",
"reference": "<string>"
}
}{
"code": "<string>",
"error": "<string>",
"details": {
"errorMessage": "<string>",
"friendlyMessage": "<string>",
"data": {
"customerId": "<string>"
}
}
}{
"code": "<string>",
"error": "<string>",
"details": {
"errorMessage": "<string>",
"friendlyMessage": "<string>",
"data": {
"customerId": "<string>"
}
}
}Create Marketplace Counter-Offer
curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parentOrderId": "<string>",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderSide": "SELL",
"clientOrderId": "<string>",
"reference": "<string>"
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer"
payload = {
"parentOrderId": "<string>",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderSide": "SELL",
"clientOrderId": "<string>",
"reference": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentOrderId: '<string>',
baseSymbol: '<string>',
quoteSymbol: '<string>',
amount: {asset: '<string>', value: '<string>'},
price: {asset: '<string>', value: '<string>'},
orderSide: 'SELL',
clientOrderId: '<string>',
reference: '<string>'
})
};
fetch('https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parentOrderId' => '<string>',
'baseSymbol' => '<string>',
'quoteSymbol' => '<string>',
'amount' => [
'asset' => '<string>',
'value' => '<string>'
],
'price' => [
'asset' => '<string>',
'value' => '<string>'
],
'orderSide' => 'SELL',
'clientOrderId' => '<string>',
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer"
payload := strings.NewReader("{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/market-place/order/counter-offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentOrderId\": \"<string>\",\n \"baseSymbol\": \"<string>\",\n \"quoteSymbol\": \"<string>\",\n \"amount\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"price\": {\n \"asset\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"orderSide\": \"SELL\",\n \"clientOrderId\": \"<string>\",\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"orderId": "BUY-12",
"baseSymbol": "<string>",
"quoteSymbol": "<string>",
"pair": "<string>",
"amount": {
"asset": "<string>",
"value": "<string>"
},
"price": {
"asset": "<string>",
"value": "<string>"
},
"orderType": "OFFER",
"orderSide": "BUY",
"status": "OPEN",
"meta": {
"timestamps": {
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"filledAt": "2023-11-07T05:31:56Z"
},
"amounts": {
"filled": {
"asset": "<string>",
"value": "<string>"
},
"remaining": {
"asset": "<string>",
"value": "<string>"
}
},
"logs": [
{
"status": "<string>",
"at": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
]
},
"parentOrderId": "<string>",
"clientOrderId": "<string>",
"reference": "<string>"
}
}{
"code": "<string>",
"error": "<string>",
"details": {
"errorMessage": "<string>",
"friendlyMessage": "<string>",
"data": {
"customerId": "<string>"
}
}
}{
"code": "<string>",
"error": "<string>",
"details": {
"errorMessage": "<string>",
"friendlyMessage": "<string>",
"data": {
"customerId": "<string>"
}
}
}Authorizations
Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.
A request whose key does not carry the permission the target
endpoint requires is rejected with 401 Unauthorized, the same
response an unrecognised, malformed, revoked or disabled key
returns. The API does not distinguish the two cases on the wire.
See the Permissions reference for the permission each endpoint requires.
Headers
Body
A counter-offer never expires: it waits for Afriex to review it. baseSymbol and quoteSymbol must match the parent order's pair.
