sFOX API
Sign InOpen Account
sFOX API
sFOX API
  • Introduction
    • Welcome
    • Getting Started
    • Systems & Operations
    • Rate Limits
  • REST API
    • REST Endpoints
    • Authentication
    • Rate Limits
    • Account Management
      • Get All Balances
      • Get All Currencies
      • Get All Currency Pairs
      • Get All Transactions
      • Get Fees
    • Orders
      • Order Types
      • Create Order
      • Cancel Order
      • Cancel Multiple Orders
      • Cancel All Orders
      • Amend Order
      • Get Single Order
      • Get All Open Orders
      • Get All Done Orders
      • Get All Trades
    • Request for Quote (RFQ)
    • Post-Trade Settlement (PTS)
      • Get Account Risk Metrics
      • Get All Positions
      • Get All Funding Transactions
      • Get All Funding Rates
      • Get All Risk Modes
      • Create Transfer
    • Shorting
      • Get Account Risk Metrics
      • Get All Positions
    • Transfers
      • Get All Deposit Addresses
      • Get Single Deposit Address
      • Create Deposit Address
      • Deposit From Bank Account
      • Withdraw From Account
      • Get Single Withdrawal Fee
      • Create Transfer
    • Custody (sFOX SAFE)
      • Get Whitelisted Addresses
      • Add Whitelisted Address
      • Delete Whitelisted Address
      • Get Approval Rules
      • Create Approval Rule
      • Edit Approval Rule
      • Get Approval Requests
      • Respond to Approval Request
    • Staking
      • Get Staking Currencies
      • Get All Staking Transactions
      • Create Stake
      • Cancel Stake
      • Unstake
    • Market Data
      • Get Candlesticks
      • Get Volume Analytics
      • Get Order Estimate
      • Get Order Book
    • Reporting
      • Get Orders Report
      • Get Monthly Summary
      • Get Portfolio Valuation
      • Get All Transactions
  • WebSocket API
    • Introduction
    • Connecting
    • Rate Limits
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • Market Data
      • Order Book
      • Trades
      • Ticker
    • Orders & Account Data
      • Orders
      • Trades
      • Balances
      • Post-Trade Settlement
  • FIX API
    • FIX Order Entry
    • FIX Market Data
    • QuickFIX Guide
  • Errors
    • Error Codes
Powered by GitBook
  1. REST API
  2. Orders

Amend Order

PATCH https://api.sfox.com/v1/orders/:order_id

Make the following adjustments to the quantity or amount, price, and stop amount or stop percent parameters of an order without canceling the order.

Path Parameters

Parameter
Type
Description

order_id required

string

The order ID generated by sFOX upon order creation.

Body Parameters

Parameter
Type
Description

quantity

number

Increase the quantity of an order.

amount

number

Increase the quantity of an order. amount may only be increased for Stop (304) and Trailing Stop (308) orders

price

number

  • BUY Orders: Increase limit price

  • SELL Orders: Decrease limit price

  • Price cannot be modified for Trailing Stop (308) order

stop_amount

number

Any modification is allowed

stop_percent

number

Any modification is allowed

Example Requests

curl -X PATCH \
  -H 'Authorization: Bearer <API_TOKEN>' \
  --data '{ "quantity": 2 }'  \
  'https://api.sfox.com/v1/orders/123'
const axios = require('axios');

axios({
  method: 'patch',
  url: 'https://api.sfox.com/v1/orders/123',
  headers: {
    'Authorization': 'Bearer <API_KEY>'
  },
  data: { quantity: 1 }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});
import requests

data = requests.patch(
  "https://api.sfox.com/v1/orders/123",
  headers={
    "Authorization": "Bearer <API_KEY>",
  },
  data={
   "quantity": 1
  }
)
print(data)
PreviousCancel All OrdersNextGet Single Order

Last updated 1 year ago