LayoutService
List Layouts
List saved layouts for the caller.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/layouts?limit=100&pageToken=eyJvZmZzZXQiOjEwMH0' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"layouts": [
{
"dockviewState": "AA==",
"isDefault": false,
"layoutId": "1",
"name": "BTC Trading",
"updatedAtMs": "1",
"viewerId": "1",
"widgets": [
{
"widgetConfig": "AA==",
"widgetId": "chart-main",
"widgetType": "CHART"
}
]
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}Maximum number of layouts to return. Defaults to 100 when omitted; maximum is 500.
Opaque keyset cursor from a previous response. The cursor is exclusive and bound to the authenticated caller and newest-updated sort order.
Viewer that owns the saved layout.
1Layout identifier unique within the viewer's saved layouts.
1Human-readable layout name.
BTC TradingTrue when this is the viewer's default layout.
falseSerialized editor panel arrangement snapshot.
AA==Stable widget identifier within the layout, such as "chart-1".
chart-mainWidget kind that determines how widget_config is decoded.
CHARTSerialized widget configuration bytes for the selected widget_type.
AA==Last update time in milliseconds since epoch (UTC).
1Opaque cursor for the next page. Empty when no more results exist.
eyJvZmZzZXQiOjIwMH0| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |