pmxtjs 2.51.1 → 2.51.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/README.md +14 -5
  2. package/dist/esm/generated/src/apis/DefaultApi.d.ts +6 -0
  3. package/dist/esm/generated/src/apis/DefaultApi.js +6 -0
  4. package/dist/esm/generated/src/models/CreateOrderParams.d.ts +20 -0
  5. package/dist/esm/generated/src/models/CreateOrderParams.js +11 -0
  6. package/dist/esm/index.d.ts +3 -2
  7. package/dist/esm/index.js +3 -2
  8. package/dist/esm/pmxt/client.d.ts +61 -12
  9. package/dist/esm/pmxt/client.js +126 -21
  10. package/dist/esm/pmxt/escrow.js +109 -10
  11. package/dist/esm/pmxt/hosted-typed-data.d.ts +1 -1
  12. package/dist/esm/pmxt/hosted-typed-data.js +14 -0
  13. package/dist/esm/pmxt/models.d.ts +17 -0
  14. package/dist/esm/pmxt/server-manager.js +5 -3
  15. package/dist/generated/src/apis/DefaultApi.d.ts +6 -0
  16. package/dist/generated/src/apis/DefaultApi.js +6 -0
  17. package/dist/generated/src/models/CreateOrderParams.d.ts +20 -0
  18. package/dist/generated/src/models/CreateOrderParams.js +12 -1
  19. package/dist/index.d.ts +3 -2
  20. package/dist/index.js +3 -1
  21. package/dist/pmxt/client.d.ts +61 -12
  22. package/dist/pmxt/client.js +126 -20
  23. package/dist/pmxt/escrow.js +109 -10
  24. package/dist/pmxt/hosted-typed-data.d.ts +1 -1
  25. package/dist/pmxt/hosted-typed-data.js +14 -0
  26. package/dist/pmxt/models.d.ts +17 -0
  27. package/dist/pmxt/server-manager.js +5 -3
  28. package/generated/docs/ArbitrageOpportunity.md +0 -29
  29. package/generated/docs/Balance.md +0 -25
  30. package/generated/docs/BaseRequest.md +0 -21
  31. package/generated/docs/BaseResponse.md +0 -22
  32. package/generated/docs/BuildOrder200Response.md +0 -23
  33. package/generated/docs/BuildOrderRequest.md +0 -22
  34. package/generated/docs/BuiltOrder.md +0 -26
  35. package/generated/docs/BuiltOrderTx.md +0 -24
  36. package/generated/docs/CancelOrderRequest.md +0 -22
  37. package/generated/docs/CloseRequest.md +0 -22
  38. package/generated/docs/CompareMarketPrices200Response.md +0 -23
  39. package/generated/docs/CompareMarketPricesRequest.md +0 -22
  40. package/generated/docs/CreateOrder200Response.md +0 -23
  41. package/generated/docs/CreateOrderParams.md +2 -30
  42. package/generated/docs/CreateOrderRequest.md +0 -22
  43. package/generated/docs/DataFeedsApi.md +0 -329
  44. package/generated/docs/DefaultApi.md +3 -1438
  45. package/generated/docs/ErrorDetail.md +0 -25
  46. package/generated/docs/ErrorResponse.md +0 -22
  47. package/generated/docs/EventFetchParams.md +0 -35
  48. package/generated/docs/EventFilterCriteria.md +0 -26
  49. package/generated/docs/EventFilterCriteriaTotalVolume.md +0 -22
  50. package/generated/docs/EventMatchResult.md +0 -22
  51. package/generated/docs/ExchangeCredentials.md +0 -29
  52. package/generated/docs/ExchangeCredentialsSignatureType.md +0 -20
  53. package/generated/docs/ExchangeOptions.md +0 -27
  54. package/generated/docs/ExecutionPriceResult.md +0 -23
  55. package/generated/docs/FeedFetchHistoricalPrices200Response.md +0 -22
  56. package/generated/docs/FeedFetchOHLCV200Response.md +0 -22
  57. package/generated/docs/FeedFetchOracleHistory200Response.md +0 -22
  58. package/generated/docs/FeedFetchOracleRound200Response.md +0 -22
  59. package/generated/docs/FeedFetchOrderBook200Response.md +0 -22
  60. package/generated/docs/FeedFetchOrderBook200ResponseData.md +0 -25
  61. package/generated/docs/FeedFetchTicker200Response.md +0 -22
  62. package/generated/docs/FeedFetchTickers200Response.md +0 -22
  63. package/generated/docs/FeedList200Response.md +0 -22
  64. package/generated/docs/FeedLoadMarkets200Response.md +0 -22
  65. package/generated/docs/FeedMarket.md +0 -27
  66. package/generated/docs/FeedOracleRound.md +0 -28
  67. package/generated/docs/FeedTicker.md +0 -42
  68. package/generated/docs/FetchArbitrage200Response.md +0 -23
  69. package/generated/docs/FetchArbitrageParams.md +0 -24
  70. package/generated/docs/FetchBalance200Response.md +0 -23
  71. package/generated/docs/FetchEvent200Response.md +0 -23
  72. package/generated/docs/FetchEventMatches200Response.md +0 -23
  73. package/generated/docs/FetchEventMatchesParams.md +0 -29
  74. package/generated/docs/FetchEvents200Response.md +0 -23
  75. package/generated/docs/FetchEventsPaginated200Response.md +0 -23
  76. package/generated/docs/FetchMarket200Response.md +0 -23
  77. package/generated/docs/FetchMarketMatches200Response.md +0 -23
  78. package/generated/docs/FetchMarketMatchesParams.md +0 -32
  79. package/generated/docs/FetchMarkets200Response.md +0 -23
  80. package/generated/docs/FetchMarketsPaginated200Response.md +0 -23
  81. package/generated/docs/FetchMatchedMarkets200Response.md +0 -23
  82. package/generated/docs/FetchMatchedMarketsParams.md +0 -24
  83. package/generated/docs/FetchMyTrades200Response.md +0 -23
  84. package/generated/docs/FetchOHLCV200Response.md +0 -23
  85. package/generated/docs/FetchOpenOrders200Response.md +0 -23
  86. package/generated/docs/FetchOrderBook200Response.md +0 -23
  87. package/generated/docs/FetchOrderBookParams.md +0 -24
  88. package/generated/docs/FetchOrderBooks200Response.md +0 -23
  89. package/generated/docs/FetchOrderBooksRequest.md +0 -22
  90. package/generated/docs/FetchPositions200Response.md +0 -23
  91. package/generated/docs/FetchSeries200Response.md +0 -23
  92. package/generated/docs/FetchTrades200Response.md +0 -23
  93. package/generated/docs/FilterEventsRequest.md +0 -22
  94. package/generated/docs/FilterEventsRequestArgsInner.md +0 -26
  95. package/generated/docs/FilterMarketsRequest.md +0 -22
  96. package/generated/docs/FilterMarketsRequestArgsInner.md +0 -31
  97. package/generated/docs/GetExecutionPrice200Response.md +0 -23
  98. package/generated/docs/GetExecutionPriceDetailed200Response.md +0 -23
  99. package/generated/docs/GetExecutionPriceDetailedRequest.md +0 -22
  100. package/generated/docs/GetExecutionPriceRequest.md +0 -22
  101. package/generated/docs/GetExecutionPriceRequestArgsInner.md +0 -27
  102. package/generated/docs/HealthCheck200Response.md +0 -22
  103. package/generated/docs/HistoryFilterParams.md +0 -24
  104. package/generated/docs/LoadMarkets200Response.md +0 -23
  105. package/generated/docs/LoadMarketsRequest.md +0 -22
  106. package/generated/docs/MarketFilterCriteria.md +0 -31
  107. package/generated/docs/MarketFilterCriteriaLiquidity.md +0 -22
  108. package/generated/docs/MarketFilterCriteriaOpenInterest.md +0 -22
  109. package/generated/docs/MarketFilterCriteriaPrice.md +0 -23
  110. package/generated/docs/MarketFilterCriteriaResolutionDate.md +0 -22
  111. package/generated/docs/MarketFilterCriteriaVolume.md +0 -22
  112. package/generated/docs/MarketFilterCriteriaVolume24h.md +0 -22
  113. package/generated/docs/MarketFilterParams.md +0 -34
  114. package/generated/docs/MarketOutcome.md +0 -26
  115. package/generated/docs/MatchResult.md +0 -27
  116. package/generated/docs/MatchedMarketPair.md +0 -30
  117. package/generated/docs/MyTradesParams.md +0 -26
  118. package/generated/docs/OHLCVParams.md +0 -24
  119. package/generated/docs/Order.md +0 -37
  120. package/generated/docs/OrderBook.md +0 -27
  121. package/generated/docs/OrderHistoryParams.md +0 -25
  122. package/generated/docs/OrderLevel.md +0 -23
  123. package/generated/docs/PaginatedEventsResult.md +0 -23
  124. package/generated/docs/PaginatedMarketsResult.md +0 -23
  125. package/generated/docs/Position.md +0 -32
  126. package/generated/docs/PriceCandle.md +0 -26
  127. package/generated/docs/PriceComparison.md +0 -27
  128. package/generated/docs/SubmitOrderRequest.md +0 -22
  129. package/generated/docs/Trade.md +0 -26
  130. package/generated/docs/TradesParams.md +0 -23
  131. package/generated/docs/UnifiedEvent.md +0 -33
  132. package/generated/docs/UnifiedMarket.md +0 -44
  133. package/generated/docs/UnifiedSeries.md +0 -31
  134. package/generated/docs/UserTrade.md +0 -32
  135. package/generated/package.json +1 -1
  136. package/generated/src/apis/DefaultApi.ts +6 -0
  137. package/generated/src/models/CreateOrderParams.ts +25 -0
  138. package/index.ts +3 -2
  139. package/package.json +2 -2
  140. package/pmxt/client.ts +153 -28
  141. package/pmxt/escrow.ts +131 -11
  142. package/pmxt/hosted-typed-data.ts +17 -1
  143. package/pmxt/models.ts +20 -0
  144. package/pmxt/server-manager.ts +5 -3
@@ -11,30 +11,6 @@ Name | Type
11
11
  `since` | number
12
12
  `until` | number
13
13
 
14
- ## Example
15
-
16
- ```typescript
17
- import type { FetchOrderBookParams } from 'pmxtjs'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "side": null,
22
- "outcome": null,
23
- "since": null,
24
- "until": null,
25
- } satisfies FetchOrderBookParams
26
-
27
- console.log(example)
28
-
29
- // Convert the instance to a JSON string
30
- const exampleJSON: string = JSON.stringify(example)
31
- console.log(exampleJSON)
32
-
33
- // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as FetchOrderBookParams
35
- console.log(exampleParsed)
36
- ```
37
-
38
14
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
15
 
40
16
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [{ [key: string]: OrderBook; }](OrderBook.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { FetchOrderBooks200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies FetchOrderBooks200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as FetchOrderBooks200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | Array<Array<string>>
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { FetchOrderBooksRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies FetchOrderBooksRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as FetchOrderBooksRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [Array<Position>](Position.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { FetchPositions200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies FetchPositions200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as FetchPositions200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [Array<UnifiedSeries>](UnifiedSeries.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { FetchSeries200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies FetchSeries200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as FetchSeries200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [Array<Trade>](Trade.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { FetchTrades200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies FetchTrades200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as FetchTrades200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | [Array<FilterEventsRequestArgsInner>](FilterEventsRequestArgsInner.md)
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { FilterEventsRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies FilterEventsRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as FilterEventsRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -13,32 +13,6 @@ Name | Type
13
13
  `marketCount` | [MarketFilterCriteriaVolume24h](MarketFilterCriteriaVolume24h.md)
14
14
  `totalVolume` | [EventFilterCriteriaTotalVolume](EventFilterCriteriaTotalVolume.md)
15
15
 
16
- ## Example
17
-
18
- ```typescript
19
- import type { FilterEventsRequestArgsInner } from 'pmxtjs'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "text": null,
24
- "searchIn": null,
25
- "category": null,
26
- "tags": null,
27
- "marketCount": null,
28
- "totalVolume": null,
29
- } satisfies FilterEventsRequestArgsInner
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as FilterEventsRequestArgsInner
39
- console.log(exampleParsed)
40
- ```
41
-
42
16
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
17
 
44
18
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | [Array<FilterMarketsRequestArgsInner>](FilterMarketsRequestArgsInner.md)
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { FilterMarketsRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies FilterMarketsRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as FilterMarketsRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -18,37 +18,6 @@ Name | Type
18
18
  `price` | [MarketFilterCriteriaPrice](MarketFilterCriteriaPrice.md)
19
19
  `priceChange24h` | [MarketFilterCriteriaPrice](MarketFilterCriteriaPrice.md)
20
20
 
21
- ## Example
22
-
23
- ```typescript
24
- import type { FilterMarketsRequestArgsInner } from 'pmxtjs'
25
-
26
- // TODO: Update the object below with actual values
27
- const example = {
28
- "text": null,
29
- "searchIn": null,
30
- "volume24h": null,
31
- "volume": null,
32
- "liquidity": null,
33
- "openInterest": null,
34
- "resolutionDate": null,
35
- "category": null,
36
- "tags": null,
37
- "price": null,
38
- "priceChange24h": null,
39
- } satisfies FilterMarketsRequestArgsInner
40
-
41
- console.log(example)
42
-
43
- // Convert the instance to a JSON string
44
- const exampleJSON: string = JSON.stringify(example)
45
- console.log(exampleJSON)
46
-
47
- // Parse the JSON string back to an object
48
- const exampleParsed = JSON.parse(exampleJSON) as FilterMarketsRequestArgsInner
49
- console.log(exampleParsed)
50
- ```
51
-
52
21
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
22
 
54
23
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { GetExecutionPrice200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies GetExecutionPrice200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as GetExecutionPrice200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [ExecutionPriceResult](ExecutionPriceResult.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { GetExecutionPriceDetailed200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies GetExecutionPriceDetailed200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as GetExecutionPriceDetailed200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | [Array<GetExecutionPriceRequestArgsInner>](GetExecutionPriceRequestArgsInner.md)
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { GetExecutionPriceDetailedRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies GetExecutionPriceDetailedRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as GetExecutionPriceDetailedRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | [Array<GetExecutionPriceRequestArgsInner>](GetExecutionPriceRequestArgsInner.md)
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { GetExecutionPriceRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies GetExecutionPriceRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as GetExecutionPriceRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -14,33 +14,6 @@ Name | Type
14
14
  `lastTradePrice` | number
15
15
  `sourceMetadata` | { [key: string]: object; }
16
16
 
17
- ## Example
18
-
19
- ```typescript
20
- import type { GetExecutionPriceRequestArgsInner } from 'pmxtjs'
21
-
22
- // TODO: Update the object below with actual values
23
- const example = {
24
- "bids": null,
25
- "asks": null,
26
- "timestamp": null,
27
- "datetime": null,
28
- "isNegRisk": null,
29
- "lastTradePrice": null,
30
- "sourceMetadata": null,
31
- } satisfies GetExecutionPriceRequestArgsInner
32
-
33
- console.log(example)
34
-
35
- // Convert the instance to a JSON string
36
- const exampleJSON: string = JSON.stringify(example)
37
- console.log(exampleJSON)
38
-
39
- // Parse the JSON string back to an object
40
- const exampleParsed = JSON.parse(exampleJSON) as GetExecutionPriceRequestArgsInner
41
- console.log(exampleParsed)
42
- ```
43
-
44
17
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
18
 
46
19
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `status` | string
10
10
  `timestamp` | number
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { HealthCheck200Response } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "status": ok,
20
- "timestamp": null,
21
- } satisfies HealthCheck200Response
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as HealthCheck200Response
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -12,30 +12,6 @@ Name | Type
12
12
  `end` | Date
13
13
  `limit` | number
14
14
 
15
- ## Example
16
-
17
- ```typescript
18
- import type { HistoryFilterParams } from 'pmxtjs'
19
-
20
- // TODO: Update the object below with actual values
21
- const example = {
22
- "resolution": null,
23
- "start": null,
24
- "end": null,
25
- "limit": null,
26
- } satisfies HistoryFilterParams
27
-
28
- console.log(example)
29
-
30
- // Convert the instance to a JSON string
31
- const exampleJSON: string = JSON.stringify(example)
32
- console.log(exampleJSON)
33
-
34
- // Parse the JSON string back to an object
35
- const exampleParsed = JSON.parse(exampleJSON) as HistoryFilterParams
36
- console.log(exampleParsed)
37
- ```
38
-
39
15
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
16
 
41
17
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `error` | [ErrorDetail](ErrorDetail.md)
11
11
  `data` | [{ [key: string]: UnifiedMarket; }](UnifiedMarket.md)
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { LoadMarkets200Response } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "success": true,
21
- "error": null,
22
- "data": null,
23
- } satisfies LoadMarkets200Response
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as LoadMarkets200Response
33
- console.log(exampleParsed)
34
- ```
35
-
36
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
14
 
38
15
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `args` | Array<boolean>
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { LoadMarketsRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies LoadMarketsRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as LoadMarketsRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
12
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
13
 
36
14
 
@@ -18,37 +18,6 @@ Name | Type
18
18
  `price` | [MarketFilterCriteriaPrice](MarketFilterCriteriaPrice.md)
19
19
  `priceChange24h` | [MarketFilterCriteriaPrice](MarketFilterCriteriaPrice.md)
20
20
 
21
- ## Example
22
-
23
- ```typescript
24
- import type { MarketFilterCriteria } from 'pmxtjs'
25
-
26
- // TODO: Update the object below with actual values
27
- const example = {
28
- "text": null,
29
- "searchIn": null,
30
- "volume24h": null,
31
- "volume": null,
32
- "liquidity": null,
33
- "openInterest": null,
34
- "resolutionDate": null,
35
- "category": null,
36
- "tags": null,
37
- "price": null,
38
- "priceChange24h": null,
39
- } satisfies MarketFilterCriteria
40
-
41
- console.log(example)
42
-
43
- // Convert the instance to a JSON string
44
- const exampleJSON: string = JSON.stringify(example)
45
- console.log(exampleJSON)
46
-
47
- // Parse the JSON string back to an object
48
- const exampleParsed = JSON.parse(exampleJSON) as MarketFilterCriteria
49
- console.log(exampleParsed)
50
- ```
51
-
52
21
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
22
 
54
23
 
@@ -10,28 +10,6 @@ Name | Type
10
10
  `min` | number
11
11
  `max` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { MarketFilterCriteriaLiquidity } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "min": null,
21
- "max": null,
22
- } satisfies MarketFilterCriteriaLiquidity
23
-
24
- console.log(example)
25
-
26
- // Convert the instance to a JSON string
27
- const exampleJSON: string = JSON.stringify(example)
28
- console.log(exampleJSON)
29
-
30
- // Parse the JSON string back to an object
31
- const exampleParsed = JSON.parse(exampleJSON) as MarketFilterCriteriaLiquidity
32
- console.log(exampleParsed)
33
- ```
34
-
35
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
14
 
37
15
 
@@ -10,28 +10,6 @@ Name | Type
10
10
  `min` | number
11
11
  `max` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { MarketFilterCriteriaOpenInterest } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "min": null,
21
- "max": null,
22
- } satisfies MarketFilterCriteriaOpenInterest
23
-
24
- console.log(example)
25
-
26
- // Convert the instance to a JSON string
27
- const exampleJSON: string = JSON.stringify(example)
28
- console.log(exampleJSON)
29
-
30
- // Parse the JSON string back to an object
31
- const exampleParsed = JSON.parse(exampleJSON) as MarketFilterCriteriaOpenInterest
32
- console.log(exampleParsed)
33
- ```
34
-
35
13
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
14
 
37
15