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
@@ -10,29 +10,6 @@ Name | Type
10
10
  `min` | number
11
11
  `max` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { MarketFilterCriteriaPrice } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "outcome": null,
21
- "min": null,
22
- "max": null,
23
- } satisfies MarketFilterCriteriaPrice
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 MarketFilterCriteriaPrice
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
  `before` | Date
10
10
  `after` | Date
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { MarketFilterCriteriaResolutionDate } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "before": null,
20
- "after": null,
21
- } satisfies MarketFilterCriteriaResolutionDate
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 MarketFilterCriteriaResolutionDate
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,28 +10,6 @@ Name | Type
10
10
  `min` | number
11
11
  `max` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { MarketFilterCriteriaVolume } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "min": null,
21
- "max": null,
22
- } satisfies MarketFilterCriteriaVolume
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 MarketFilterCriteriaVolume
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
 
@@ -9,28 +9,6 @@ Name | Type
9
9
  `min` | number
10
10
  `max` | number
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { MarketFilterCriteriaVolume24h } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "min": null,
20
- "max": null,
21
- } satisfies MarketFilterCriteriaVolume24h
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 MarketFilterCriteriaVolume24h
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
 
@@ -21,40 +21,6 @@ Name | Type
21
21
  `sourceExchange` | string
22
22
  `exchange` | string
23
23
 
24
- ## Example
25
-
26
- ```typescript
27
- import type { MarketFilterParams } from 'pmxtjs'
28
-
29
- // TODO: Update the object below with actual values
30
- const example = {
31
- "limit": null,
32
- "offset": null,
33
- "sort": null,
34
- "status": null,
35
- "searchIn": null,
36
- "query": null,
37
- "slug": null,
38
- "marketId": null,
39
- "outcomeId": null,
40
- "eventId": null,
41
- "page": null,
42
- "similarityThreshold": null,
43
- "sourceExchange": null,
44
- "exchange": null,
45
- } satisfies MarketFilterParams
46
-
47
- console.log(example)
48
-
49
- // Convert the instance to a JSON string
50
- const exampleJSON: string = JSON.stringify(example)
51
- console.log(exampleJSON)
52
-
53
- // Parse the JSON string back to an object
54
- const exampleParsed = JSON.parse(exampleJSON) as MarketFilterParams
55
- console.log(exampleParsed)
56
- ```
57
-
58
24
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
59
25
 
60
26
 
@@ -13,32 +13,6 @@ Name | Type
13
13
  `priceChange24h` | number
14
14
  `metadata` | { [key: string]: any; }
15
15
 
16
- ## Example
17
-
18
- ```typescript
19
- import type { MarketOutcome } from 'pmxtjs'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "outcomeId": null,
24
- "marketId": null,
25
- "label": null,
26
- "price": null,
27
- "priceChange24h": null,
28
- "metadata": null,
29
- } satisfies MarketOutcome
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 MarketOutcome
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
 
@@ -14,33 +14,6 @@ Name | Type
14
14
  `bestBid` | number
15
15
  `bestAsk` | number
16
16
 
17
- ## Example
18
-
19
- ```typescript
20
- import type { MatchResult } from 'pmxtjs'
21
-
22
- // TODO: Update the object below with actual values
23
- const example = {
24
- "market": null,
25
- "sourceMarket": null,
26
- "relation": null,
27
- "confidence": null,
28
- "reasoning": null,
29
- "bestBid": null,
30
- "bestAsk": null,
31
- } satisfies MatchResult
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 MatchResult
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
 
@@ -17,36 +17,6 @@ Name | Type
17
17
  `confidence` | number
18
18
  `reasoning` | string
19
19
 
20
- ## Example
21
-
22
- ```typescript
23
- import type { MatchedMarketPair } from 'pmxtjs'
24
-
25
- // TODO: Update the object below with actual values
26
- const example = {
27
- "marketA": null,
28
- "marketB": null,
29
- "priceDifference": null,
30
- "venueA": null,
31
- "venueB": null,
32
- "priceA": null,
33
- "priceB": null,
34
- "relation": null,
35
- "confidence": null,
36
- "reasoning": null,
37
- } satisfies MatchedMarketPair
38
-
39
- console.log(example)
40
-
41
- // Convert the instance to a JSON string
42
- const exampleJSON: string = JSON.stringify(example)
43
- console.log(exampleJSON)
44
-
45
- // Parse the JSON string back to an object
46
- const exampleParsed = JSON.parse(exampleJSON) as MatchedMarketPair
47
- console.log(exampleParsed)
48
- ```
49
-
50
20
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
21
 
52
22
 
@@ -13,32 +13,6 @@ Name | Type
13
13
  `limit` | number
14
14
  `cursor` | string
15
15
 
16
- ## Example
17
-
18
- ```typescript
19
- import type { MyTradesParams } from 'pmxtjs'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "outcomeId": null,
24
- "marketId": null,
25
- "since": null,
26
- "until": null,
27
- "limit": null,
28
- "cursor": null,
29
- } satisfies MyTradesParams
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 MyTradesParams
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
 
@@ -11,30 +11,6 @@ Name | Type
11
11
  `end` | Date
12
12
  `limit` | number
13
13
 
14
- ## Example
15
-
16
- ```typescript
17
- import type { OHLCVParams } from 'pmxtjs'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "resolution": null,
22
- "start": null,
23
- "end": null,
24
- "limit": null,
25
- } satisfies OHLCVParams
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 OHLCVParams
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
 
@@ -24,43 +24,6 @@ Name | Type
24
24
  `chain` | string
25
25
  `blockNumber` | number
26
26
 
27
- ## Example
28
-
29
- ```typescript
30
- import type { Order } from 'pmxtjs'
31
-
32
- // TODO: Update the object below with actual values
33
- const example = {
34
- "id": null,
35
- "marketId": null,
36
- "outcomeId": null,
37
- "side": null,
38
- "type": null,
39
- "price": null,
40
- "amount": null,
41
- "status": null,
42
- "filled": null,
43
- "filledShares": null,
44
- "remaining": null,
45
- "timestamp": null,
46
- "fee": null,
47
- "feeRateBps": null,
48
- "txHash": null,
49
- "chain": null,
50
- "blockNumber": null,
51
- } satisfies Order
52
-
53
- console.log(example)
54
-
55
- // Convert the instance to a JSON string
56
- const exampleJSON: string = JSON.stringify(example)
57
- console.log(exampleJSON)
58
-
59
- // Parse the JSON string back to an object
60
- const exampleParsed = JSON.parse(exampleJSON) as Order
61
- console.log(exampleParsed)
62
- ```
63
-
64
27
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
65
28
 
66
29
 
@@ -14,33 +14,6 @@ Name | Type
14
14
  `lastTradePrice` | number
15
15
  `sourceMetadata` | { [key: string]: any; }
16
16
 
17
- ## Example
18
-
19
- ```typescript
20
- import type { OrderBook } 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 OrderBook
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 OrderBook
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
 
@@ -12,31 +12,6 @@ Name | Type
12
12
  `limit` | number
13
13
  `cursor` | string
14
14
 
15
- ## Example
16
-
17
- ```typescript
18
- import type { OrderHistoryParams } from 'pmxtjs'
19
-
20
- // TODO: Update the object below with actual values
21
- const example = {
22
- "marketId": null,
23
- "since": null,
24
- "until": null,
25
- "limit": null,
26
- "cursor": null,
27
- } satisfies OrderHistoryParams
28
-
29
- console.log(example)
30
-
31
- // Convert the instance to a JSON string
32
- const exampleJSON: string = JSON.stringify(example)
33
- console.log(exampleJSON)
34
-
35
- // Parse the JSON string back to an object
36
- const exampleParsed = JSON.parse(exampleJSON) as OrderHistoryParams
37
- console.log(exampleParsed)
38
- ```
39
-
40
15
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
16
 
42
17
 
@@ -10,29 +10,6 @@ Name | Type
10
10
  `size` | number
11
11
  `orderCount` | number
12
12
 
13
- ## Example
14
-
15
- ```typescript
16
- import type { OrderLevel } from 'pmxtjs'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "price": null,
21
- "size": null,
22
- "orderCount": null,
23
- } satisfies OrderLevel
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 OrderLevel
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
 
@@ -11,29 +11,6 @@ Name | Type
11
11
  `total` | number
12
12
  `nextCursor` | string
13
13
 
14
- ## Example
15
-
16
- ```typescript
17
- import type { PaginatedEventsResult } from 'pmxtjs'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "data": null,
22
- "total": null,
23
- "nextCursor": null,
24
- } satisfies PaginatedEventsResult
25
-
26
- console.log(example)
27
-
28
- // Convert the instance to a JSON string
29
- const exampleJSON: string = JSON.stringify(example)
30
- console.log(exampleJSON)
31
-
32
- // Parse the JSON string back to an object
33
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedEventsResult
34
- console.log(exampleParsed)
35
- ```
36
-
37
14
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
15
 
39
16
 
@@ -11,29 +11,6 @@ Name | Type
11
11
  `total` | number
12
12
  `nextCursor` | string
13
13
 
14
- ## Example
15
-
16
- ```typescript
17
- import type { PaginatedMarketsResult } from 'pmxtjs'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "data": null,
22
- "total": null,
23
- "nextCursor": null,
24
- } satisfies PaginatedMarketsResult
25
-
26
- console.log(example)
27
-
28
- // Convert the instance to a JSON string
29
- const exampleJSON: string = JSON.stringify(example)
30
- console.log(exampleJSON)
31
-
32
- // Parse the JSON string back to an object
33
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedMarketsResult
34
- console.log(exampleParsed)
35
- ```
36
-
37
14
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
15
 
39
16
 
@@ -20,38 +20,6 @@ Name | Type
20
20
  `chain` | string
21
21
  `blockNumber` | number
22
22
 
23
- ## Example
24
-
25
- ```typescript
26
- import type { Position } from 'pmxtjs'
27
-
28
- // TODO: Update the object below with actual values
29
- const example = {
30
- "marketId": null,
31
- "outcomeId": null,
32
- "outcomeLabel": null,
33
- "size": null,
34
- "entryPrice": null,
35
- "currentPrice": null,
36
- "currentValue": null,
37
- "unrealizedPnL": null,
38
- "realizedPnL": null,
39
- "txHash": null,
40
- "chain": null,
41
- "blockNumber": null,
42
- } satisfies Position
43
-
44
- console.log(example)
45
-
46
- // Convert the instance to a JSON string
47
- const exampleJSON: string = JSON.stringify(example)
48
- console.log(exampleJSON)
49
-
50
- // Parse the JSON string back to an object
51
- const exampleParsed = JSON.parse(exampleJSON) as Position
52
- console.log(exampleParsed)
53
- ```
54
-
55
23
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
56
24
 
57
25
 
@@ -13,32 +13,6 @@ Name | Type
13
13
  `close` | number
14
14
  `volume` | number
15
15
 
16
- ## Example
17
-
18
- ```typescript
19
- import type { PriceCandle } from 'pmxtjs'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "timestamp": null,
24
- "open": null,
25
- "high": null,
26
- "low": null,
27
- "close": null,
28
- "volume": null,
29
- } satisfies PriceCandle
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 PriceCandle
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
 
@@ -14,33 +14,6 @@ Name | Type
14
14
  `bestAsk` | number
15
15
  `venue` | string
16
16
 
17
- ## Example
18
-
19
- ```typescript
20
- import type { PriceComparison } from 'pmxtjs'
21
-
22
- // TODO: Update the object below with actual values
23
- const example = {
24
- "market": null,
25
- "relation": null,
26
- "confidence": null,
27
- "reasoning": null,
28
- "bestBid": null,
29
- "bestAsk": null,
30
- "venue": null,
31
- } satisfies PriceComparison
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 PriceComparison
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
  `args` | [Array<BuiltOrder>](BuiltOrder.md)
10
10
  `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
11
11
 
12
- ## Example
13
-
14
- ```typescript
15
- import type { SubmitOrderRequest } from 'pmxtjs'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "args": null,
20
- "credentials": null,
21
- } satisfies SubmitOrderRequest
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 SubmitOrderRequest
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