COcopper-co
orders

Create Order

post/orders

Request

Request body

agentAddressstring

Agent address for orders created by agents on behalf of users

agentNamestring

Agent name for orders created by agents on behalf of users

agentValidUntilstring

Expiration date (unix timestamp in millis) of Hyperliquid agent wallet

amountstring

The amount of order in baseCurrency

baseCurrencystring required

The currency of the order amount

blockchainTransactionType'send' | 'multi-withdraw' | 'account-set' | 'approve-hot-key' | 'approve-builder-fee' | 'allowance' | 'smart-call' | 'multi-smart-call' | 'activate' | 'activate-trading' | 'stake-delegation' | 'stake-nomination' | 'stake-undelegation' | 'complete-withdrawal' | 'stake-complete-deposit' | 'take-reward' | 'claim-builder-rewards' | 'pool-creation' | 'edit-pool' | 'governance-vote' | 'unjail' | 'importance-transfer' | 'transfer-stake' | 'rebond-stake' | 'chill' | 'cross-chain-send' | 'accept-deposit' | 'reject-deposit' | 'allocate' | 'reject-allocation' | 'create-allocation-request' | 'settle-allocations' | 'cancel-allocations' | 'create-referral' | 'set-referral' | 'set-trading'
builderFeeAddressstring

Builder fee address for Hyperliquid builder approval and activation

deliveryType'free-of-payment' | 'payment-vs-payment'
descriptionstring

The description of the order

externalBroadcastboolean

Sets broadcast mode. If true: manual broadcast. If false: automatic broadcast. Copper automatically broadcasts transactions to the network after fully signing

externalOrderIdstring required

Unique order identifier from client (should be unique for the portfolio)

feeLevel'low' | 'medium' | 'high'
includeFeeInWithdrawboolean

Indicates, whether the fee should be included in the withdrawal amount or added on top of it

limitType'otc' | 'rfq'
mainCurrencystring

The main currency of the base currency

masterPasswordstring

A SHA-256 encrypted hash of the withdrawal password (also known as master password), if required.

memostring

Withdraw memo (destination tag for XRP)

netuidstring

Subnet Network ID in TAO blockchain

optInReferralProgramboolean

Opt in to the referral program during Hyperliquid activation

orderType'sell' | 'buy' | 'deposit' | 'withdraw' | 'multi-withdraw' | 'wallet-message' | 'retrieved-deposit' | 'earn-reward' | 'earn-shared-reward' | 'claim-shared-reward' | 'cross-chain-deposit' | 'cross-chain-withdraw' required
payloadstring

Serialised data payload for a smart contract

payloadsstring[]

Serialised list of unsigned transactions. For Ethereum only type 0 (legacy) transactions are supported

portfolioIdstring required

The ID of the portfolio where the order should be placed

priceLimitstring

The price of the order in quote currency, only applicable for settle orders

quoteAmountstring

The amount of order in quoteCurrency

quoteCurrencystring

The currency of the quote amount

quoteMainCurrencystring

The main currency of the quote currency

referralCodestring

Referral code

toAddressstring

The address where the funds should be transferred

toCounterpartyIdstring

The ID of the counterparty to transfer money to

toCryptoAddressIdstring

In case of a withdrawal, the destination crypto address ID from an Address Book

toPortfolioIdstring

In case of a withdrawal on a different portfolio, the portfolio ID of the destination account

userAbstractstring

Example request

{
  "amount": "0.1",
  "baseCurrency": "BTC",
  "description": "Withdrawal to my wallet",
  "quoteAmount": "10",
  "quoteCurrency": "USD",
  "toReceivers": [
    {
      "amount": "0.1"
    }
  ]
}

Response

OK

amountstring required

Amount of order in baseCurrency

baseCurrencystring required

Base currency of the order

createdAtstring required

Order creation timestamp

createdBystring

Creator user id

externalOrderIdstring required

The order ID in the external system

limitType'otc' | 'rfq'
mainCurrencystring

Blockchain network of a baseCurrency

orderIdstring required

Order ID

orderType'sell' | 'buy' | 'deposit' | 'withdraw' | 'multi-withdraw' | 'wallet-message' | 'retrieved-deposit' | 'earn-reward' | 'earn-shared-reward' | 'claim-shared-reward' | 'cross-chain-deposit' | 'cross-chain-withdraw' required
organizationIdstring

Organization id

portfolioIdstring required

Portfolio ID

portfolioType'custody' | 'trading-vault' | 'trading' | 'external' | 'clearloop' required
quoteCurrencystring

The quote currency of the order (in case of a settle order)

quoteMainCurrencystring

Blockchain network of a quoteCurrency

status'new' | 'waiting-funds' | 'reserving' | 'reserved' | 'queued' | 'validating-funds' | 'working' | 'waiting-approve' | 'co-sign-require' | 'approved' | 'processing' | 'executed' | 'canceled' | 'rejecting' | 'rejected' | 'declining' | 'declined' | 'suspending' | 'suspended' | 'blocked' | 'action-required' | 'accepting' | 'accepted' | 'require-initializer-approve' | 'waiting-counterparty-approve' | 'require-counterparty-approve' | 'ready-for-settlement' | 'settled' | 'part-signed-tx-added' | 'full-signed-tx-added' | 'rejected-part-signed-tx-added' | 'rejected-full-signed-tx-added' | 'accepted-part-signed-tx-added' | 'accepted-full-signed-tx-added' | 'awaiting-settlement' | 'master-password-required' | 'manual-resolving' | 'error' | 'pending-atomic-settlement-confirmation' | 'atomic-settlement-reservation-completed' | 'require-finalize' | 'waiting-accept-deposit' | 'waiting-reject-deposit' required
terminatedAtstring

Order termination timestamp

updatedAtstring

Order update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.