curl --request POST \
--url https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}
'import requests
url = "https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit"
payload = {
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
symbol: 'BTC/USDCx:USDCx',
type: 'limit',
side: 'buy',
amount: 0.002,
price: 64500
})
};
fetch('https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));use reqwest::blocking::Client;
use serde_json::json;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = Client::new()
.post("https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit")
.bearer_auth(std::env::var("EDEL_API_KEY")?)
.header("Idempotency-Key", "<Idempotency-Key>")
.json(&json!({
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}))
.send()?;
println!("{} {}", response.status(), response.text()?);
Ok(())
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit"
payload := strings.NewReader("{\n \"symbol\": \"BTC/USDCx:USDCx\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"amount\": 0.002,\n \"price\": 64500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"symbol\": \"BTC/USDCx:USDCx\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"amount\": 0.002,\n \"price\": 64500\n}")
.asString();{
"id": "<string>",
"symbol": "<string>",
"status": "open",
"info": {
"version": "external-order/v1",
"orderId": "<string>",
"accountId": "<string>",
"marketId": "<string>",
"status": "open",
"lastSequence": 1,
"idempotencyKey": "<string>",
"postOnly": true,
"icebergQty": 123,
"side": "buy",
"orderType": "limit",
"price": "<string>",
"priceAtoms": "<string>",
"quantityAtoms": "<string>",
"filledQuantityAtoms": "<string>",
"productType": "spot",
"lockAsset": "<string>",
"lockedAtoms": "<string>",
"remainingQuantityAtoms": "<string>",
"createdAtEpochMs": 1,
"filledQuoteAtoms": "<string>",
"cancelReason": "margin_unbacked",
"quantity": "<string>",
"filledQuantity": "<string>",
"createdJournalSequence": 1,
"updatedJournalSequence": 1
},
"clientOrderId": null,
"timestamp": null,
"datetime": null,
"lastUpdateTimestamp": 1,
"side": null,
"type": null,
"timeInForce": "GTC",
"price": null,
"amount": null,
"filled": null,
"remaining": null,
"reduceOnly": null,
"postOnly": null,
"lastTradeTimestamp": null,
"cost": null,
"trades": [],
"fee": null
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}Edit one order (perps)
Perpetual markets only. The id of an order of a spot market answers not_found.
EditOrder(id, symbol, type, side, amount, price): amends an owned resting limit order in place through the same replace controller as POST /v1/orders/:orderId/replace. The order keeps its id, side, post-only and reduce-only settings; it takes the new price and the new TOTAL amount (what has filled plus what rests afterwards), which must be greater than the filled amount, else 409 invalid_quantity. type must be limit, and side must be the order’s own side (400 invalid_request otherwise). The order keeps its place in the queue only when the price is unchanged and the amount goes down; any other change moves it to the back at the new price, and a price that crosses the book trades as a taker first unless the order is post-only (409 post_only_would_cross, order unchanged). The checks of a new order apply: order intake, market status, price and size limits, the minimum order notional and the margin or balance for any increase. Every refusal leaves the order unchanged. Unknown, terminal, filled, wrong-market and other-account ids all answer OrderNotFound (404 not_found). While the venue’s replace switch is off the answer is 400 operation_not_available. Requires an Idempotency-Key; an exact replay answers the original response.
curl --request POST \
--url https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}
'import requests
url = "https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit"
payload = {
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
symbol: 'BTC/USDCx:USDCx',
type: 'limit',
side: 'buy',
amount: 0.002,
price: 64500
})
};
fetch('https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));use reqwest::blocking::Client;
use serde_json::json;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = Client::new()
.post("https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit")
.bearer_auth(std::env::var("EDEL_API_KEY")?)
.header("Idempotency-Key", "<Idempotency-Key>")
.json(&json!({
"symbol": "BTC/USDCx:USDCx",
"type": "limit",
"side": "buy",
"amount": 0.002,
"price": 64500
}))
.send()?;
println!("{} {}", response.status(), response.text()?);
Ok(())
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit"
payload := strings.NewReader("{\n \"symbol\": \"BTC/USDCx:USDCx\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"amount\": 0.002,\n \"price\": 64500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://testnet.edel-api.xyz/v2/perps/orders/{orderId}/edit")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"symbol\": \"BTC/USDCx:USDCx\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"amount\": 0.002,\n \"price\": 64500\n}")
.asString();{
"id": "<string>",
"symbol": "<string>",
"status": "open",
"info": {
"version": "external-order/v1",
"orderId": "<string>",
"accountId": "<string>",
"marketId": "<string>",
"status": "open",
"lastSequence": 1,
"idempotencyKey": "<string>",
"postOnly": true,
"icebergQty": 123,
"side": "buy",
"orderType": "limit",
"price": "<string>",
"priceAtoms": "<string>",
"quantityAtoms": "<string>",
"filledQuantityAtoms": "<string>",
"productType": "spot",
"lockAsset": "<string>",
"lockedAtoms": "<string>",
"remainingQuantityAtoms": "<string>",
"createdAtEpochMs": 1,
"filledQuoteAtoms": "<string>",
"cancelReason": "margin_unbacked",
"quantity": "<string>",
"filledQuantity": "<string>",
"createdJournalSequence": 1,
"updatedJournalSequence": 1
},
"clientOrderId": null,
"timestamp": null,
"datetime": null,
"lastUpdateTimestamp": 1,
"side": null,
"type": null,
"timeInForce": "GTC",
"price": null,
"amount": null,
"filled": null,
"remaining": null,
"reduceOnly": null,
"postOnly": null,
"lastTradeTimestamp": null,
"cost": null,
"trades": [],
"fee": null
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}{
"name": "AccountNotEnabled",
"message": "<string>",
"code": "promo_code_unknown",
"retryable": true,
"timestamp": 1,
"datetime": "<string>",
"info": {
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "promo_code_unknown",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"featureFlag": "<string>",
"orderOutcome": "not_submitted",
"clientOrderIds": [
"<string>"
],
"reconciliation": "<string>",
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "custodial_signer_environment_not_service_held",
"withdrawalFailure": "spot_disabled",
"feeShareAcceptRefusal": "challenge_missing",
"dependency": "dfns",
"squidRouteRefusal": "route_not_found",
"positionSnapshotRefusal": "position_projection_behind_live",
"setupKeyRefusal": "setup_key_refused"
}
}BASE/QUOTE:SETTLE format. Read Which symbol format.Authorizations
The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field. When invitation-only access is enabled, private operations require the account's sign-in email to be invited. Sign-in can complete without an invitation, but private HTTP, MCP and FIX operations refuse with access_not_allowlisted (HTTP 403): "Private access is limited to invited accounts. Contact support to request access." Public market data remains available. Invitation changes apply to the next private operation, including existing FIX sessions. Do not retry until support confirms access.
Body
Response
Accepted for processing
- Option 1
- Option 2
- Option 3
1 to 256 ASCII letters, digits, periods, underscores, colons or hyphens. Canonical bot identifiers also allow the fixed bot-order/v1: prefix followed by an optional sha256: marker and 64 lowercase hexadecimal digits.
1 - 256^(?:[A-Za-z0-9._:-]+|bot-order\/v1:(?:sha256:)?[a-f0-9]{64})$