ethereal_rust_sdk 0.1.9

Trading client for Ethereal exchange
Documentation 
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
159
160
161
162
163
164
165
166
167
168
169
170
171

# \PositionApi

All URIs are relative to *https://api.ethereal.trade*

Method | HTTP request | Description
------------- | ------------- | -------------
[**position_controller_get_active**](PositionApi.md#position_controller_get_active) | **GET** /v1/position/active | Returns the active position for a subaccount and product
[**position_controller_get_by_id**](PositionApi.md#position_controller_get_by_id) | **GET** /v1/position/{id} | Returns position by id
[**position_controller_list_by_subaccount_id**](PositionApi.md#position_controller_list_by_subaccount_id) | **GET** /v1/position | Returns a filtered list of positions for a given subaccount
[**position_controller_list_fills_by_position_id**](PositionApi.md#position_controller_list_fills_by_position_id) | **GET** /v1/position/fill | Returns a filtered list of fills for a given position
[**position_controller_list_liquidations_by_subaccount_id**](PositionApi.md#position_controller_list_liquidations_by_subaccount_id) | **GET** /v1/position/liquidation | Returns a list of liquidations



## position_controller_get_active

> models::PositionDto position_controller_get_active(subaccount_id, product_id)
Returns the active position for a subaccount and product

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**subaccount_id** | **uuid::Uuid** | Id representing the registered subaccount | [required] |
**product_id** | **uuid::Uuid** | Id of product to filter position by | [required] |

### Return type

[**models::PositionDto**](PositionDto.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## position_controller_get_by_id

> models::PositionDto position_controller_get_by_id(id)
Returns position by id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**models::PositionDto**](PositionDto.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## position_controller_list_by_subaccount_id

> models::PageOfPositionDtos position_controller_list_by_subaccount_id(subaccount_id, order, limit, cursor, product_ids, open, order_by, created_after, created_before, side, is_liquidated)
Returns a filtered list of positions for a given subaccount

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**subaccount_id** | **uuid::Uuid** | Id representing the registered subaccount | [required] |
**order** | Option<**String**> | Direction to paginate through objects |  |
**limit** | Option<**f64**> | Limit the number of objects to return |  |
**cursor** | Option<**String**> | Pointer to the current object in pagination dataset |  |
**product_ids** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Array of product ids to filter for |  |
**open** | Option<**bool**> | Include or exclude open positions (i.e. non-zero size) |  |
**order_by** | Option<**String**> | Order by field |  |
**created_after** | Option<**f64**> | Filter by order fills created before timestamp exclusive (ms since Unix epoch) |  |
**created_before** | Option<**f64**> | Filter by order fills created before timestamp inclusive (ms since Unix epoch) |  |
**side** | Option<**f64**> | Side as either BUY (0) or SELL (1) |  |
**is_liquidated** | Option<**bool**> | Filter by liquidated positions |  |

### Return type

[**models::PageOfPositionDtos**](PageOfPositionDtos.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## position_controller_list_fills_by_position_id

> models::PageOfPositionFillDtos position_controller_list_fills_by_position_id(position_id, order, limit, cursor, order_by)
Returns a filtered list of fills for a given position

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**position_id** | **uuid::Uuid** | Id of the position to filter fills by | [required] |
**order** | Option<**String**> | Direction to paginate through objects |  |
**limit** | Option<**f64**> | Limit the number of objects to return |  |
**cursor** | Option<**String**> | Pointer to the current object in pagination dataset |  |
**order_by** | Option<**String**> | Order by field |  |

### Return type

[**models::PageOfPositionFillDtos**](PageOfPositionFillDtos.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## position_controller_list_liquidations_by_subaccount_id

> models::PageOfPositionLiquidationsDto position_controller_list_liquidations_by_subaccount_id(order, limit, cursor, order_by)
Returns a list of liquidations

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**order** | Option<**String**> | Direction to paginate through objects |  |
**limit** | Option<**f64**> | Limit the number of objects to return |  |
**cursor** | Option<**String**> | Pointer to the current object in pagination dataset |  |
**order_by** | Option<**String**> | Order by field |  |

### Return type

[**models::PageOfPositionLiquidationsDto**](PageOfPositionLiquidationsDto.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)