All Trade Platforms
GET /api/TradePlatforms
Responses
- 200 Success — TradePlatform[]
Example
curl "https://cloud.mywebapi.com/api/TradePlatforms" \
-H "Authorization: Bearer $TOKEN"
API v1 (stable) · General · 3 operations ·
base URL https://cloud.mywebapi.com ·
OpenAPI v1 (JSON) ·
Redoc
Manage trade platforms
Every call needs Authorization: Bearer $TOKEN — an OAuth 2.0 client-credentials token from
https://auth.cplugin.net/connect/token (scope webapi).
$TRADE_PLATFORM_ID is the id of a trade platform registered in Toolbox.
GET /api/TradePlatforms
curl "https://cloud.mywebapi.com/api/TradePlatforms" \
-H "Authorization: Bearer $TOKEN"GET /api/TradePlatforms/{tradePlatform}
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tradePlatform | path | string (uuid) | yes | |
| X-Request-Timeout | header | number (double) | no | How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header. |
curl "https://cloud.mywebapi.com/api/TradePlatforms/$TRADE_PLATFORM_ID" \
-H "Authorization: Bearer $TOKEN"GET /api/TradePlatforms/{tradePlatform}/Ping
try to connect and call Ping using Manager API
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tradePlatform | path | string (uuid) | yes | |
| X-Request-Timeout | header | number (double) | no | How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header. |
curl "https://cloud.mywebapi.com/api/TradePlatforms/$TRADE_PLATFORM_ID/Ping" \
-H "Authorization: Bearer $TOKEN"Types the operations above take and return, with their first-level properties; * marks a required one. The full graph is in the OpenAPI specification.
| Property | Type | Description |
|---|---|---|
| id | string (uuid) | |
| name | string, nullable | |
| type | TradePlatformType | |
| organizationId | string (uuid) | |
| organization | Organization | |
| created | string (date-time) |
Values: MT4, MT5, MatchTrader
| Property | Type | Description |
|---|---|---|
| id | string (uuid) | |
| name | string, nullable | |
| created | string (date-time) |