documentation-public/llms.config.json at main · OrderlyNetwork/documentation-public · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{
  "site": {
    "name": "Orderly Network",
    "baseUrl": "https://orderly.network/docs",
    "description": "Orderly is an omnichain orderbook-based trading infrastructure providing perpetual futures liquidity for decentralized exchanges.",
    "apiBase": {
      "mainnet": "https://api.orderly.org/",
      "testnet": "https://testnet-api.orderly.org"
    },
    "auth": "Authentication uses ed25519 signatures. Symbol format: PERP_<TOKEN>_USDC."
  },
  "compactSections": [
    {
      "title": "Getting Started",
      "routes": [
        "introduction/getting-started/what-is-orderly",
        "introduction/getting-started/builder-onboarding",
        "build-on-omnichain/building-on-omnichain",
        "build-on-omnichain/integration-checklist"
      ]
    },
    {
      "title": "Authentication",
      "routes": [
        "build-on-omnichain/api-authentication",
        "build-on-omnichain/user-flows/wallet-authentication"
      ]
    },
    {
      "title": "Accounts and Funding",
      "routes": [
        "build-on-omnichain/user-flows/accounts",
        "build-on-omnichain/user-flows/withdrawal-deposit"
      ]
    },
    {
      "title": "Order Lifecycle",
      "routes": [
        "build-on-omnichain/user-flows/order-management",
        "build-on-omnichain/restful-api/private/create-order",
        "build-on-omnichain/restful-api/private/cancel-order",
        "build-on-omnichain/restful-api/private/get-orders"
      ]
    },
    {
      "title": "Isolated Margin",
      "routes": [
        "build-on-omnichain/user-flows/isolated-margin",
        "introduction/trade-on-orderly/perpetual-futures/isolated-margin",
        "build-on-omnichain/restful-api/private/update-margin-mode",
        "build-on-omnichain/restful-api/private/get-margin-modes",
        "build-on-omnichain/restful-api/private/add-or-reduce-position-margin"
      ]
    },
    {
      "title": "Transfers and Settlement",
      "routes": [
        "build-on-omnichain/user-flows/internal-transfer",
        "build-on-omnichain/user-flows/settle-pnl",
        "build-on-omnichain/restful-api/private/create-internal-transfer"
      ]
    },
    {
      "title": "SDK Setup",
      "routes": [
        "sdks/overview",
        "sdks/react/getting_started",
        "sdks/hooks/setup"
      ]
    },
    {
      "title": "WebSocket & Real-Time Data",
      "routes": [
        "build-on-omnichain/websocket-api/introduction",
        "build-on-omnichain/websocket-api/public/orderbook",
        "build-on-omnichain/websocket-api/public/trade",
        "build-on-omnichain/websocket-api/private/execution-report"
      ]
    },
    {
      "title": "API Reference",
      "routes": [
        "build-on-omnichain/introduction",
        "build-on-omnichain/error-codes"
      ]
    },
    {
      "title": "Chains & Contracts",
      "routes": [
        "introduction/trade-on-orderly/supported-chains",
        "build-on-omnichain/addresses"
      ]
    },
    {
      "title": "Troubleshooting",
      "routes": [
        "troubleshooting/introduction",
        "troubleshooting/user-issues/transaction-failures",
        "troubleshooting/user-issues/withdrawal-issues"
      ]
    }
  ],
  "canonicalPages": [
    "home",
    "introduction/getting-started/what-is-orderly",
    "introduction/getting-started/builder-onboarding",
    "build-on-omnichain/building-on-omnichain",
    "build-on-omnichain/integration-checklist",
    "build-on-omnichain/user-flows/accounts",
    "build-on-omnichain/api-authentication",
    "build-on-omnichain/user-flows/wallet-authentication",
    "build-on-omnichain/user-flows/withdrawal-deposit",
    "build-on-omnichain/user-flows/order-management",
    "build-on-omnichain/user-flows/isolated-margin",
    "build-on-omnichain/restful-api/private/update-margin-mode",
    "build-on-omnichain/restful-api/private/get-margin-modes",
    "build-on-omnichain/restful-api/private/add-or-reduce-position-margin",
    "build-on-omnichain/restful-api/private/get-account-information",
    "build-on-omnichain/restful-api/private/get-all-positions-info",
    "build-on-omnichain/restful-api/public/register-account",
    "introduction/trade-on-orderly/perpetual-futures/isolated-margin",
    "build-on-omnichain/user-flows/internal-transfer",
    "build-on-omnichain/user-flows/settle-pnl",
    "sdks/overview",
    "sdks/react/getting_started",
    "sdks/hooks/setup",
    "build-on-omnichain/websocket-api/introduction",
    "build-on-omnichain/websocket-api/public/orderbook",
    "build-on-omnichain/websocket-api/public/trade",
    "build-on-omnichain/websocket-api/private/execution-report",
    "build-on-omnichain/introduction",
    "build-on-omnichain/error-codes",
    "introduction/trade-on-orderly/supported-chains",
    "build-on-omnichain/addresses",
    "troubleshooting/introduction",
    "troubleshooting/user-issues/transaction-failures",
    "troubleshooting/user-issues/withdrawal-issues"
  ],
  "pageContract": {
    "requiredSections": [],
    "requiredFrontmatter": [
      "title",
      "description"
    ],
    "enforceOnCanonicalPages": true
  },
  "verification": {
    "forbiddenRoutePatterns": [
      "build-on-omnichain/user-flows/builder-staking-programme",
      "build-on-omnichain/restful-api/private/get-sub-account",
      "strategy-vault/strategy-vault/"
    ],
    "readOnlyGeneratedDirectories": [
      "build-on-omnichain/restful-api",
      "sdks/tech-doc"
    ]
  }
}