pmxtjs 0.4.3 → 1.0.0-b2

package/generated/docs/ErrorDetail.md

@@ -0,0 +1,34 @@
+
+# ErrorDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { ErrorDetail } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies ErrorDetail
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorDetail
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/ErrorResponse.md

@@ -0,0 +1,36 @@
+
+# ErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+
+## Example
+
+```typescript
+import type { ErrorResponse } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": false,
+  "error": null,
+} satisfies ErrorResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchBalance200Response.md

@@ -0,0 +1,38 @@
+
+# FetchBalance200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<Balance>](Balance.md)
+
+## Example
+
+```typescript
+import type { FetchBalance200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchBalance200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchBalance200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchMarkets200Response.md

@@ -0,0 +1,38 @@
+
+# FetchMarkets200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<UnifiedMarket>](UnifiedMarket.md)
+
+## Example
+
+```typescript
+import type { FetchMarkets200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchMarkets200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchMarkets200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchMarketsRequest.md

@@ -0,0 +1,34 @@
+
+# FetchMarketsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | [Array<MarketFilterParams>](MarketFilterParams.md)
+
+## Example
+
+```typescript
+import type { FetchMarketsRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies FetchMarketsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchMarketsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOHLCV200Response.md

@@ -0,0 +1,38 @@
+
+# FetchOHLCV200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<PriceCandle>](PriceCandle.md)
+
+## Example
+
+```typescript
+import type { FetchOHLCV200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchOHLCV200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOHLCV200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOHLCVRequest.md

@@ -0,0 +1,34 @@
+
+# FetchOHLCVRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | [Array<FetchOHLCVRequestArgsInner>](FetchOHLCVRequestArgsInner.md)
+
+## Example
+
+```typescript
+import type { FetchOHLCVRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": ["0x123...",{"resolution":"1h"}],
+} satisfies FetchOHLCVRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOHLCVRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOHLCVRequestArgsInner.md

@@ -0,0 +1,40 @@
+
+# FetchOHLCVRequestArgsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`resolution` | string
+`start` | Date
+`end` | Date
+`limit` | number
+
+## Example
+
+```typescript
+import type { FetchOHLCVRequestArgsInner } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "resolution": null,
+  "start": null,
+  "end": null,
+  "limit": null,
+} satisfies FetchOHLCVRequestArgsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOHLCVRequestArgsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOpenOrders200Response.md

@@ -0,0 +1,38 @@
+
+# FetchOpenOrders200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<Order>](Order.md)
+
+## Example
+
+```typescript
+import type { FetchOpenOrders200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchOpenOrders200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOpenOrders200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOpenOrdersRequest.md

@@ -0,0 +1,34 @@
+
+# FetchOpenOrdersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | Array<string>
+
+## Example
+
+```typescript
+import type { FetchOpenOrdersRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies FetchOpenOrdersRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOpenOrdersRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOrderBook200Response.md

@@ -0,0 +1,38 @@
+
+# FetchOrderBook200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [OrderBook](OrderBook.md)
+
+## Example
+
+```typescript
+import type { FetchOrderBook200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchOrderBook200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOrderBook200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchOrderBookRequest.md

@@ -0,0 +1,34 @@
+
+# FetchOrderBookRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | Array<string>
+
+## Example
+
+```typescript
+import type { FetchOrderBookRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies FetchOrderBookRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchOrderBookRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchPositions200Response.md

@@ -0,0 +1,38 @@
+
+# FetchPositions200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<Position>](Position.md)
+
+## Example
+
+```typescript
+import type { FetchPositions200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchPositions200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchPositions200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchPositionsRequest.md

@@ -0,0 +1,34 @@
+
+# FetchPositionsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | Array<any>
+
+## Example
+
+```typescript
+import type { FetchPositionsRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies FetchPositionsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchPositionsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchTrades200Response.md

@@ -0,0 +1,38 @@
+
+# FetchTrades200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | [ErrorDetail](ErrorDetail.md)
+`data` | [Array<Trade>](Trade.md)
+
+## Example
+
+```typescript
+import type { FetchTrades200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "error": null,
+  "data": null,
+} satisfies FetchTrades200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchTrades200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/FetchTradesRequest.md

@@ -0,0 +1,34 @@
+
+# FetchTradesRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | [Array<FetchOHLCVRequestArgsInner>](FetchOHLCVRequestArgsInner.md)
+
+## Example
+
+```typescript
+import type { FetchTradesRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies FetchTradesRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FetchTradesRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/GetMarketsBySlugRequest.md

@@ -0,0 +1,34 @@
+
+# GetMarketsBySlugRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`args` | Array<string>
+
+## Example
+
+```typescript
+import type { GetMarketsBySlugRequest } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "args": null,
+} satisfies GetMarketsBySlugRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetMarketsBySlugRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/HealthCheck200Response.md

@@ -0,0 +1,36 @@
+
+# HealthCheck200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`timestamp` | number
+
+## Example
+
+```typescript
+import type { HealthCheck200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": ok,
+  "timestamp": null,
+} satisfies HealthCheck200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as HealthCheck200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+