How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Orderly Network

Orderly Network private API

The private API from Orderly Network — 137 operation(s) for private.

Documentation Provider Profile APIs.io OpenAPI GitHub

Orderly Network private API is one of 4 APIs that Orderly Network publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Private. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 149 operations across 137 paths, and defines 134 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.orderly.org, https://testnet-api.orderly.org.

149 operations 137 paths 134 schemas 8 DELETE89 GET49 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.orderly.org
Resource Areas
1

Paths & Operations 149

Across 137 paths, the API surfaces 149 operations — 8 DELETE, 89 GET, 49 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

private 149
POST
/v1/client/add_sub_account
Add sub account
4 params body → 200
GET
/v1/client/sub_account
Get sub account list
4 params → 200
POST
/v1/client/update_sub_account
Update sub account
4 params body → 200
GET
/v1/client/aggregate/positions
Get aggregate positions
4 params → 200
GET
/v1/client/aggregate/holding
Get aggregate holding
4 params → 200
POST
/v1/sub_account_settle_pnl
Settle sub account PnL
4 params body → 200
GET
/v1/positions
Get all positions info
4 params → 200
GET
/v1/positions_lite
Get lite positions info
4 params → 200
GET
/v1/position/{symbol}
Get one position info
6 params → 200
GET
/v1/position_history
Get position history
6 params → 200
GET
/v1/funding_fee/history
Get funding fee history
9 params → 200
GET
/v1/client/leverage
Get leverage setting
6 params → 200
GET
/v1/client/leverages
Get all leverage settings
4 params → 200
POST
/v1/client/leverages
Update leverage setting
4 params body → 200
GET
/v1/liquidations
Get liquidated positions of account
11 params → 200
POST
/v1/liquidation
Claim liquidated positions
4 params body → 200
GET
/v1/client/liquidator_liquidations
Get liquidated positions by liquidator
9 params → 200
POST
/v1/order
Create order
5 params body → 200
DELETE
/v1/order
Cancel order
6 params → 200
PUT
/v1/order
Edit order
4 params body → 200
GET
/v1/order/{order_id}
Get order by orderid
5 params → 200
GET
/v1/trades
Get trades
9 params → 200
GET
/v1/client/holding
Get current holding
5 params → 200
GET
/v1/account_info
Get account overview info
4 params → 200
POST
/v1/client/margin_mode
Update margin mode
4 params body → 200
POST
/v1/position_margin
Add or reduce position margin
4 params body → 200
GET
/v1/client/margin_modes
Get margin modes
4 params → 200
GET
/v1/client/info
Get account information
4 params → 200
GET
/v1/orders
Get orders
14 params → 200
DELETE
/v1/orders
Cancel all pending orders
5 params → 200
GET
/v1/client/statistics
Get user statistics
4 params → 200
GET
/v1/asset/history
Get asset history
11 params → 200
GET
/v1/client/asset/receiver_address
Get receiver address
6 params → 200
GET
/v1/client/asset/receiver_events
Get receiver events
4 params → 200
POST
/v1/claim_insurance_fund
Claim insurance fund
4 params body → 200
POST
/v1/client/remove_orderly_key
Remove Orderly key
body → 200
POST
/v1/order/cancel_all_after
Cancel all after
4 params body → 200
POST
/v1/batch-order
Batch create order
5 params body → 200
DELETE
/v1/batch-order
Batch cancel orders
5 params → 200
DELETE
/v1/client/order
Cancel order by clientorderid
6 params → 200
DELETE
/v1/client/batch-order
Batch cancel orders by clientorderid
5 params → 200
GET
/v1/client/order/{client_order_id}
Get order by clientorderid
5 params → 200
GET
/v1/orderbook/{symbol}
Orderbook snapshot
6 params → 200
GET
/v1/order/{order_id}/trades
Get all trades of specific order
5 params → 200
GET
/v1/trade/{trade_id}
Get trade
5 params → 200
POST
/v1/client/maintenance_config
Configure auto-cancel during maintenance
4 params body → 200
GET
/v1/volume/user/stats
Get user volume statistics
4 params → 200
GET
/v1/volume/user/daily
Get user daily volume
6 params → 200
GET
/v1/withdraw_nonce
Get withdrawal nonce
4 params → 200
GET
/v1/settle_nonce
Get settle PnL nonce
4 params → 200
POST
/v1/withdraw_request
Create withdraw request
4 params body → 200
POST
/v1/settle_pnl
Request PnL settlement
4 params body → 200
GET
/v1/pnl_settlement/history
Get PnL settlement history
8 params → 200
POST
/v1/internal_transfer
Create internal transfer
4 params body → 200
POST
/v2/internal_transfer
Create internal transfer with wallet signature
4 params body → 200
GET
/v1/transfer_nonce
Get transfer nonce
4 params → 200
GET
/v1/internal_transfer_history
Get internal transfer history
13 params → 200
GET
/v1/client/key_info
Get current Orderly key info
5 params → 200
GET
/v1/client/orderly_key_ip_restriction
Get Orderly key IP restriction
5 params → 200
POST
/v1/client/set_orderly_key_ip_restriction
Set Orderly key IP restriction
6 params → 200
POST
/v1/client/reset_orderly_key_ip_restriction
Reset Orderly key IP restriction
6 params → 200
GET
/v1/notification/inbox/notifications
Get all notifications
7 params → 200
GET
/v1/notification/inbox/unread
Get unread notifications
4 params → 200
POST
/v1/notification/inbox/mark_read
Set read status of notifications
6 params → 200
POST
/v1/notification/inbox/mark_read_all
Set read status of all notifications
5 params → 200
POST
/v1/algo/order
Create algo order
5 params body → 200
PUT
/v1/algo/order
Edit algo order
4 params body → 200
DELETE
/v1/algo/order
Cancel algo order
6 params → 200
DELETE
/v1/algo/client/order
Cancel algo order by clientorderid
6 params → 200
DELETE
/v1/algo/orders
Cancel all pending algo orders
6 params → 200
GET
/v1/algo/orders
Get algo orders
15 params → 200
GET
/v1/algo/order/{order_id}
Get algo order by orderid
5 params → 200
GET
/v1/algo/client/order/{client_order_id}
Get algo order by clientorderid
5 params → 200
GET
/v1/algo/order/{order_id}/trades
Get all trades of specific algo order
5 params → 200
GET
/v1/volume/broker/daily
Get builder's users' volumes
12 params → 200
GET
/v1/broker/leaderboard/daily
Get builder's leaderboard
9 params → 200
GET
/v1/broker/broker_info
Get builder fee tier information
4 params → 200
GET
/v1/broker/daily_fee_revenue
Get builder's daily revenue settlement history
6 params → 200400
GET
/v1/client/statistics/daily
Get user daily statistics
9 params → 200
GET
/v1/broker/user_info
Get user fee rates
8 params → 200
POST
/v1/broker/fee_rate/set
Update user fee rate
4 params body → 200
POST
/v1/broker/fee_rate/set_default
Reset user fee rate
4 params body → 200
POST
/v1/broker/fee_rate/default
Update default builder fee
4 params body → 200
GET
/v1/broker/fee_rate/default
Get default builder fee
4 params → 200
POST
/v1/referral/create
Create referral code
4 params body → 200
GET
/v1/referral/admin_info
Get referral code info
9 params → 200
POST
/v1/referral/update
Update referral code
4 params body → 200
POST
/v1/referral/bind
Bind referral code
4 params body → 200
GET
/v1/referral/info
Get referral info
4 params → 200
GET
/v1/referral/referral_history
Get referral history
8 params → 200
GET
/v1/referral/rebate_summary
Get referral rebate summary
8 params → 200
GET
/v1/referral/referee_history
Get referee history
8 params → 200
GET
/v1/referral/referee_info
Get referee info
7 params → 200
GET
/v1/referral/referee_rebate_summary
Get referee rebate summary
6 params → 200
POST
/v1/referral/edit_split
Edit referral code split
4 params body → 200
POST
/v1/referral/auto_referral/update
Builder admin update auto referral
4 params body → 200
GET
/v1/referral/auto_referral/info
Builder admin get auto referral info
4 params → 200
GET
/v1/referral/auto_referral/progress
Get auto referral progress
4 params → 200
POST
/v1/referral/edit_referral_code
Edit referral code
4 params body → 200
GET
/v1/referral/multi_level/max_rebate_rate
Get max rebate rate
4 params → 200
POST
/v1/referral/multi_level/claim_code
Claim referral code
4 params body → 200
GET
/v1/referral/multi_level/rebate_info
Get rebate info
4 params → 200
POST
/v1/referral/multi_level/rebate_rate/update
Update referee rebate rate
4 params body → 200
POST
/v1/referral/multi_level/rebate_rate/set_default
Reset referee rebate rate
4 params body → 200
GET
/v1/referral/multi_level/statistics
Get multilevel statistics
5 params → 200
GET
/v1/referral/multi_level/referee_list
Get referee list
9 params → 200
GET
/v1/referral/multi_level/volume_prerequisite
Get volume prerequisite
4 params → 200
POST
/v1/referral/multi_level/admin
Enable or configure multilevel referral
4 params body → 200
GET
/v1/referral/multi_level/admin
Get multilevel referral config
4 params → 200
POST
/v1/referral/multi_level/admin/update
Update multilevel referral config
4 params body → 200
POST
/v1/referral/multi_level/admin/update/affiliate
Update L1 affiliate rebate rate
4 params body → 200
POST
/v1/referral/multi_level/admin/reset/affiliate
Reset L1 affiliate rebate rate
4 params body → 200
GET
/v1/referral/multi_level/admin/info
Get multilevel info
12 params → 200
GET
/v1/referral/multi_level/admin/referee_list
Get admin referee list
11 params → 200
GET
/v1/referral/multi_level/admin/summary
Get multilevel summary info
12 params → 200
POST
/v1/referral/multi_level/admin/create/affiliate
Create multilevel referral code on affiliate's behalf
4 params body → 200
GET
/v1/admin/points/stage
Get stage parameters
5 params → 200
POST
/v1/admin/points/stage
Create/update stage parameters
4 params body → 200
POST
/v1/delegate_withdraw_request
Delegate signer withdraw request
4 params body → 200
POST
/v1/delegate_settle_pnl
Delegate signer settle PnL
4 params body → 200
GET
/v1/client/distribution_history
Get distribution history
10 params → 200
POST
/v1/client/campaign/sign_up
Sign up campaign
body → 200
GET
/v1/staking/balance
Get wallet's current staked balance
1 param → 200
GET
/v1/staking/unstake_details
Get unstaking order details
1 param → 200
GET
/v1/staking/valor2/redeem
Get valor2 redeem info
1 param → 200
GET
/v1/staking/valor/redeem
Get valor redeem info
1 param → 200
GET
/v1/staking/esorder/vesting_list
Get esorder vesting list
2 params → 200
POST
/v1/sv/sp_orderly_key
Add SP Orderly key
body → 200
POST
/v1/sv/sp_settle_pnl
Request SP PnL settlement
body → 200
POST
/v1/sv/manual_period_delivery
Trigger manual period delivery
4 params body → 200
GET
/v1/admin/client/info
Get account information
6 params → 200
GET
/v1/admin/client/holding
Get current holding
7 params → 200
GET
/v1/admin/internal_transfer_history
Get internal transfer history
15 params → 200
GET
/v1/admin/asset/history
Get asset history
13 params → 200
GET
/v1/admin/client/leverage
Get leverage setting
7 params → 200
GET
/v1/admin/orders
Get orders
16 params → 200
GET
/v1/admin/position/{symbol}
Get one position info
7 params → 200
GET
/v1/admin/positions
Get all positions info
6 params → 200
GET
/v1/admin/funding_fee/history
Get funding fee history
11 params → 200
GET
/v1/admin/volume/user/stats
Get user volume statistics
6 params → 200
GET
/v1/admin/liquidations
Get liquidated positions (admin)
13 params → 200
GET
/v1/admin/algo/orders
Get algo orders (admin)
17 params → 200
GET
/v1/admin/trades
Get trades (admin)
11 params → 200
POST
/v1/broker/order_enum
Create order tag
4 params body → 200
PUT
/v1/broker/order_enum/{enum_id}
Update order tag
5 params body → 200
GET
/v1/broker/order_enum/{enum_id}
Get single order tag with stats
5 params → 200
GET
/v1/broker/order_enums
List all order tags for a builder
7 params → 200
POST
/v1/broker/order_enum/archive
Archive an order tag
4 params body → 200
POST
/v1/broker/order_enum/unarchive
Unarchive an order tag
4 params body → 200

Schemas 134

The contract defines 134 schemas that model the data the API accepts and returns. The most detailed are Order (24 properties), AlgoOrder (24 properties), Position (24 properties), PositionLite (22 properties). Each schema is shown below with its type and property counts.

CreateInternalTransferV1Response
GetVolumePrerequisiteResponse
DeleteAllPendingAlgoOrderResponse
CreateInternalTransferRequest
object
2 properties
GetReferralHistoryResponse
IpRestrictionResponse
SettleNonceResponse
KeyInfoResponse
Position
object
24 properties
GetUserDailyStatsResponse
LeverageResponse
AlgoOrder
object
24 properties 20 required
ClaimInsuranceFundBody
object
4 properties 3 required
WithdrawRequestBody
object
4 properties 4 required
Order
object
24 properties 18 required
AlgoOrderTradesResponse
LiquidatorLiquidationsResponse
OrderBody
object
11 properties 4 required
TradeResponse
CancelAllAfterResponse
Trade
object
17 properties
ClientHoldingResponse
FundingFeeHistoryResponse
OrderTradesResponse
CreateUpdateStageRequest
object
9 properties 7 required
GetRefereeListResponse
DeleteOrderResponse
GetMultiLevelAdminInfoResponse
SetIpRestrictionResponse
LeaderboardResponse
OrdersResponse
PositionHistoryResponse
OrderStatus
string
LeveragesResponse
PostOrderResponse
CreateAlgoOrderChildRequest
object
8 properties
GetAdminRefereeListResponse
GetInternalTransferHistoryResponse
AdminAlgoOrdersResponse
GetMultiLevelAdminSummaryResponse
ClientOrderResponse
BatchCreateOrderBody
object
10 properties 3 required
ClientStatisticsResponse
AggregateHoldingResponse
AdminLiquidationsResponse
GetUnstakeDetailsResponse
UserFeeRatesResponse
AlgoClientOrderResponse
PositionsLiteResponse
GetValorRedeemInfoResponse
GetReferralInfoResponse
ReceiverEventsResponse
GetBrokerInfoResponse
UnreadNotificationsResponse
CancelAllAfterBody
object
1 property 1 required
AlgoOrderResponse
GetValor2RedeemInfoResponse
GetRefereeRebateSummaryResponse
AutoReferralProgressResponse
GetReferralCodeResponse
GetWalletStakedBalanceResponse
PositionResponse
ArchiveOrderEnumResponse
BuilderAutoReferralInfoResponse
OrderEnum
object
6 properties
SubAccountResponse
PostLiquidationResponse
LiquidationBody
object
5 properties 3 required
PnlSettlementHistoryResponse
ClaimCodeResponse
SettlePnlBody
object
4 properties 4 required
GetBrokerDailyResponse
ClientInfoResponse
CreatedOrder
object
6 properties
OrderbookResponse
WithdrawResponse
PostOrderBody
object
14 properties 3 required
CreateInternalTransferV2Response
GetStageParametersResponse
WithdrawNonceReponse
OrderEnumWithStats
BatchOrderResponse
AggregatePositionsResponse
GetDistributionHistoryResponse
AdminTradesResponse
AlgoOrdersResponse
Notification
object
14 properties
GetBuilderDailyFeeRevenueResponse
GetesORDERVestingListResponse
MarginModesResponse
GetOrderEnumWithStatsResponse
PerpPosition
object
6 properties
TradesResponse
RemoveOrderlyKeyBody
object
1 property 1 required
OrderbookEntry
object
2 properties 2 required
ReceiverAddressResponse
CreateOrderEnumBody
object
5 properties 2 required
UpdateOrderEnumBody
object
4 properties
AccountInfoResponse
PositionsResponse
AlgoTrade
object
13 properties
GetRefereeHistoryResponse
ClientMaintenanceConfigResponse
OrderResponse
GetRebateSummaryResponse
DelegateWithdrawRequestBody
object
4 properties 4 required
AllNotificationsResponse
PositionLite
object
22 properties
UnarchiveOrderEnumResponse
EnableMultiLevelResponse
CreatedAlgoOrder
object
4 properties 4 required
PaginationMeta
object
3 properties 3 required
AssetHistoryResponse
GetOrderEnumsWithStatsResponse
GetTransferNonceResponse
VolumeStatsResponse
DailyVolumeResponse
ClaimInsuranceFundResponse
AddSubAccountResponse
CreateInternalTransferV2Request
object
4 properties
ClientMaintenanceConfigBody
object
1 property 1 required
PostAlgoOrderResponse
GetDefaultBrokerFeesResponse
BasicResponse
object
2 properties 1 required
LiquidationsResponse
PutOrderResponse
GetMultiLevelAdminConfigResponse
GetMultiLevelStatisticsResponse
SettlePnlResponse
GetRebateInfoResponse
GetRefereeInfoResponse
DelegateSettlePnlBody
object
4 properties 4 required
GetMaxRebateRateResponse
EditAlgoOrderChildRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orderly-network-private-api-openapi.yml Raw ↑

Other APIs Orderly Network publishes across the network.

Orderly Network admin API
AE Profile APIs.io
Orderly Network client API
AE Profile APIs.io
Orderly Network public API
AE Profile APIs.io
#Private
← Back to O APIs
API Details
ID
orderly-network:orderly-network-private-api
Base URL
https://api.orderly.org
Docs
https://orderly.network/docs/build-on-omnichain/introduction
Provider
Orderly Network
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=orderly-network-private-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/orderly-network-private-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Orderly Network private API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.