pmxtjs 2.18.1 → 2.19.4
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.
- package/dist/esm/generated/src/apis/DefaultApi.d.ts +53 -1
- package/dist/esm/generated/src/apis/DefaultApi.js +83 -1
- package/dist/esm/generated/src/models/BuildOrder200Response.d.ts +46 -0
- package/dist/esm/generated/src/models/BuildOrder200Response.js +47 -0
- package/dist/esm/generated/src/models/BuildOrderRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/BuildOrderRequest.js +47 -0
- package/dist/esm/generated/src/models/BuiltOrder.d.ts +60 -0
- package/dist/esm/generated/src/models/BuiltOrder.js +51 -0
- package/dist/esm/generated/src/models/BuiltOrderTx.d.ts +50 -0
- package/dist/esm/generated/src/models/BuiltOrderTx.js +47 -0
- package/dist/esm/generated/src/models/SubmitOrderRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/SubmitOrderRequest.js +47 -0
- package/dist/esm/generated/src/models/index.d.ts +5 -0
- package/dist/esm/generated/src/models/index.js +5 -0
- package/dist/generated/src/apis/DefaultApi.d.ts +53 -1
- package/dist/generated/src/apis/DefaultApi.js +83 -1
- package/dist/generated/src/models/BuildOrder200Response.d.ts +46 -0
- package/dist/generated/src/models/BuildOrder200Response.js +54 -0
- package/dist/generated/src/models/BuildOrderRequest.d.ts +40 -0
- package/dist/generated/src/models/BuildOrderRequest.js +54 -0
- package/dist/generated/src/models/BuiltOrder.d.ts +60 -0
- package/dist/generated/src/models/BuiltOrder.js +58 -0
- package/dist/generated/src/models/BuiltOrderTx.d.ts +50 -0
- package/dist/generated/src/models/BuiltOrderTx.js +54 -0
- package/dist/generated/src/models/SubmitOrderRequest.d.ts +40 -0
- package/dist/generated/src/models/SubmitOrderRequest.js +54 -0
- package/dist/generated/src/models/index.d.ts +5 -0
- package/dist/generated/src/models/index.js +5 -0
- package/generated/.openapi-generator/FILES +10 -0
- package/generated/docs/BuildOrder200Response.md +38 -0
- package/generated/docs/BuildOrderRequest.md +36 -0
- package/generated/docs/BuiltOrder.md +43 -0
- package/generated/docs/BuiltOrderTx.md +41 -0
- package/generated/docs/DefaultApi.md +142 -0
- package/generated/docs/SubmitOrderRequest.md +36 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +127 -0
- package/generated/src/models/BuildOrder200Response.ts +96 -0
- package/generated/src/models/BuildOrderRequest.ts +89 -0
- package/generated/src/models/BuiltOrder.ts +112 -0
- package/generated/src/models/BuiltOrderTx.ts +89 -0
- package/generated/src/models/SubmitOrderRequest.ts +89 -0
- package/generated/src/models/index.ts +5 -0
- package/package.json +2 -2
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* PMXT Sidecar API
|
|
6
|
+
* A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.4.4
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfBuiltOrderTx = instanceOfBuiltOrderTx;
|
|
17
|
+
exports.BuiltOrderTxFromJSON = BuiltOrderTxFromJSON;
|
|
18
|
+
exports.BuiltOrderTxFromJSONTyped = BuiltOrderTxFromJSONTyped;
|
|
19
|
+
exports.BuiltOrderTxToJSON = BuiltOrderTxToJSON;
|
|
20
|
+
exports.BuiltOrderTxToJSONTyped = BuiltOrderTxToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the BuiltOrderTx interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfBuiltOrderTx(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function BuiltOrderTxFromJSON(json) {
|
|
28
|
+
return BuiltOrderTxFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function BuiltOrderTxFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'to': json['to'] == null ? undefined : json['to'],
|
|
36
|
+
'data': json['data'] == null ? undefined : json['data'],
|
|
37
|
+
'value': json['value'] == null ? undefined : json['value'],
|
|
38
|
+
'chainId': json['chainId'] == null ? undefined : json['chainId'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function BuiltOrderTxToJSON(json) {
|
|
42
|
+
return BuiltOrderTxToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function BuiltOrderTxToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'to': value['to'],
|
|
50
|
+
'data': value['data'],
|
|
51
|
+
'value': value['value'],
|
|
52
|
+
'chainId': value['chainId'],
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PMXT Sidecar API
|
|
3
|
+
* A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.4.4
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { BuiltOrder } from './BuiltOrder';
|
|
13
|
+
import type { ExchangeCredentials } from './ExchangeCredentials';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface SubmitOrderRequest
|
|
18
|
+
*/
|
|
19
|
+
export interface SubmitOrderRequest {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {Array<BuiltOrder>}
|
|
23
|
+
* @memberof SubmitOrderRequest
|
|
24
|
+
*/
|
|
25
|
+
args: Array<BuiltOrder>;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {ExchangeCredentials}
|
|
29
|
+
* @memberof SubmitOrderRequest
|
|
30
|
+
*/
|
|
31
|
+
credentials?: ExchangeCredentials;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the SubmitOrderRequest interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfSubmitOrderRequest(value: object): value is SubmitOrderRequest;
|
|
37
|
+
export declare function SubmitOrderRequestFromJSON(json: any): SubmitOrderRequest;
|
|
38
|
+
export declare function SubmitOrderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitOrderRequest;
|
|
39
|
+
export declare function SubmitOrderRequestToJSON(json: any): SubmitOrderRequest;
|
|
40
|
+
export declare function SubmitOrderRequestToJSONTyped(value?: SubmitOrderRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* PMXT Sidecar API
|
|
6
|
+
* A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.4.4
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfSubmitOrderRequest = instanceOfSubmitOrderRequest;
|
|
17
|
+
exports.SubmitOrderRequestFromJSON = SubmitOrderRequestFromJSON;
|
|
18
|
+
exports.SubmitOrderRequestFromJSONTyped = SubmitOrderRequestFromJSONTyped;
|
|
19
|
+
exports.SubmitOrderRequestToJSON = SubmitOrderRequestToJSON;
|
|
20
|
+
exports.SubmitOrderRequestToJSONTyped = SubmitOrderRequestToJSONTyped;
|
|
21
|
+
const BuiltOrder_1 = require("./BuiltOrder");
|
|
22
|
+
const ExchangeCredentials_1 = require("./ExchangeCredentials");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the SubmitOrderRequest interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfSubmitOrderRequest(value) {
|
|
27
|
+
if (!('args' in value) || value['args'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
function SubmitOrderRequestFromJSON(json) {
|
|
32
|
+
return SubmitOrderRequestFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
function SubmitOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'args': (json['args'].map(BuiltOrder_1.BuiltOrderFromJSON)),
|
|
40
|
+
'credentials': json['credentials'] == null ? undefined : (0, ExchangeCredentials_1.ExchangeCredentialsFromJSON)(json['credentials']),
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
function SubmitOrderRequestToJSON(json) {
|
|
44
|
+
return SubmitOrderRequestToJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function SubmitOrderRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
47
|
+
if (value == null) {
|
|
48
|
+
return value;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'args': (value['args'].map(BuiltOrder_1.BuiltOrderToJSON)),
|
|
52
|
+
'credentials': (0, ExchangeCredentials_1.ExchangeCredentialsToJSON)(value['credentials']),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
export * from './Balance';
|
|
2
2
|
export * from './BaseRequest';
|
|
3
3
|
export * from './BaseResponse';
|
|
4
|
+
export * from './BuildOrder200Response';
|
|
5
|
+
export * from './BuildOrderRequest';
|
|
6
|
+
export * from './BuiltOrder';
|
|
7
|
+
export * from './BuiltOrderTx';
|
|
4
8
|
export * from './CancelOrderRequest';
|
|
5
9
|
export * from './CloseRequest';
|
|
6
10
|
export * from './CreateOrder200Response';
|
|
@@ -68,6 +72,7 @@ export * from './OrderLevel';
|
|
|
68
72
|
export * from './PaginatedMarketsResult';
|
|
69
73
|
export * from './Position';
|
|
70
74
|
export * from './PriceCandle';
|
|
75
|
+
export * from './SubmitOrderRequest';
|
|
71
76
|
export * from './Trade';
|
|
72
77
|
export * from './TradesParams';
|
|
73
78
|
export * from './UnifiedEvent';
|
|
@@ -19,6 +19,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
19
19
|
__exportStar(require("./Balance"), exports);
|
|
20
20
|
__exportStar(require("./BaseRequest"), exports);
|
|
21
21
|
__exportStar(require("./BaseResponse"), exports);
|
|
22
|
+
__exportStar(require("./BuildOrder200Response"), exports);
|
|
23
|
+
__exportStar(require("./BuildOrderRequest"), exports);
|
|
24
|
+
__exportStar(require("./BuiltOrder"), exports);
|
|
25
|
+
__exportStar(require("./BuiltOrderTx"), exports);
|
|
22
26
|
__exportStar(require("./CancelOrderRequest"), exports);
|
|
23
27
|
__exportStar(require("./CloseRequest"), exports);
|
|
24
28
|
__exportStar(require("./CreateOrder200Response"), exports);
|
|
@@ -86,6 +90,7 @@ __exportStar(require("./OrderLevel"), exports);
|
|
|
86
90
|
__exportStar(require("./PaginatedMarketsResult"), exports);
|
|
87
91
|
__exportStar(require("./Position"), exports);
|
|
88
92
|
__exportStar(require("./PriceCandle"), exports);
|
|
93
|
+
__exportStar(require("./SubmitOrderRequest"), exports);
|
|
89
94
|
__exportStar(require("./Trade"), exports);
|
|
90
95
|
__exportStar(require("./TradesParams"), exports);
|
|
91
96
|
__exportStar(require("./UnifiedEvent"), exports);
|
|
@@ -5,6 +5,10 @@ README.md
|
|
|
5
5
|
docs/Balance.md
|
|
6
6
|
docs/BaseRequest.md
|
|
7
7
|
docs/BaseResponse.md
|
|
8
|
+
docs/BuildOrder200Response.md
|
|
9
|
+
docs/BuildOrderRequest.md
|
|
10
|
+
docs/BuiltOrder.md
|
|
11
|
+
docs/BuiltOrderTx.md
|
|
8
12
|
docs/CancelOrderRequest.md
|
|
9
13
|
docs/CloseRequest.md
|
|
10
14
|
docs/CreateOrder200Response.md
|
|
@@ -73,6 +77,7 @@ docs/OrderLevel.md
|
|
|
73
77
|
docs/PaginatedMarketsResult.md
|
|
74
78
|
docs/Position.md
|
|
75
79
|
docs/PriceCandle.md
|
|
80
|
+
docs/SubmitOrderRequest.md
|
|
76
81
|
docs/Trade.md
|
|
77
82
|
docs/TradesParams.md
|
|
78
83
|
docs/UnifiedEvent.md
|
|
@@ -88,6 +93,10 @@ src/index.ts
|
|
|
88
93
|
src/models/Balance.ts
|
|
89
94
|
src/models/BaseRequest.ts
|
|
90
95
|
src/models/BaseResponse.ts
|
|
96
|
+
src/models/BuildOrder200Response.ts
|
|
97
|
+
src/models/BuildOrderRequest.ts
|
|
98
|
+
src/models/BuiltOrder.ts
|
|
99
|
+
src/models/BuiltOrderTx.ts
|
|
91
100
|
src/models/CancelOrderRequest.ts
|
|
92
101
|
src/models/CloseRequest.ts
|
|
93
102
|
src/models/CreateOrder200Response.ts
|
|
@@ -155,6 +164,7 @@ src/models/OrderLevel.ts
|
|
|
155
164
|
src/models/PaginatedMarketsResult.ts
|
|
156
165
|
src/models/Position.ts
|
|
157
166
|
src/models/PriceCandle.ts
|
|
167
|
+
src/models/SubmitOrderRequest.ts
|
|
158
168
|
src/models/Trade.ts
|
|
159
169
|
src/models/TradesParams.ts
|
|
160
170
|
src/models/UnifiedEvent.ts
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# BuildOrder200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`success` | boolean
|
|
10
|
+
`error` | [ErrorDetail](ErrorDetail.md)
|
|
11
|
+
`data` | [BuiltOrder](BuiltOrder.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { BuildOrder200Response } 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 BuildOrder200Response
|
|
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 BuildOrder200Response
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# BuildOrderRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`args` | [Array<CreateOrderParams>](CreateOrderParams.md)
|
|
10
|
+
`credentials` | [ExchangeCredentials](ExchangeCredentials.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { BuildOrderRequest } from 'pmxtjs'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"args": null,
|
|
20
|
+
"credentials": null,
|
|
21
|
+
} satisfies BuildOrderRequest
|
|
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 BuildOrderRequest
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# BuiltOrder
|
|
3
|
+
|
|
4
|
+
An order built but not yet submitted, ready for inspection or middleware forwarding
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`exchange` | string
|
|
11
|
+
`params` | [CreateOrderParams](CreateOrderParams.md)
|
|
12
|
+
`signedOrder` | { [key: string]: any; }
|
|
13
|
+
`tx` | [BuiltOrderTx](BuiltOrderTx.md)
|
|
14
|
+
`raw` | any
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { BuiltOrder } from 'pmxtjs'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"exchange": null,
|
|
24
|
+
"params": null,
|
|
25
|
+
"signedOrder": null,
|
|
26
|
+
"tx": null,
|
|
27
|
+
"raw": null,
|
|
28
|
+
} satisfies BuiltOrder
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as BuiltOrder
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# BuiltOrderTx
|
|
3
|
+
|
|
4
|
+
For on-chain AMM exchanges: the EVM transaction payload (reserved for future use)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`to` | string
|
|
11
|
+
`data` | string
|
|
12
|
+
`value` | string
|
|
13
|
+
`chainId` | number
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { BuiltOrderTx } from 'pmxtjs'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"to": null,
|
|
23
|
+
"data": null,
|
|
24
|
+
"value": null,
|
|
25
|
+
"chainId": null,
|
|
26
|
+
} satisfies BuiltOrderTx
|
|
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 BuiltOrderTx
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -4,6 +4,7 @@ All URIs are relative to *http://localhost:3847*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**buildOrder**](DefaultApi.md#buildorderoperation) | **POST** /api/{exchange}/buildOrder | Build Order |
|
|
7
8
|
| [**cancelOrder**](DefaultApi.md#cancelorderoperation) | **POST** /api/{exchange}/cancelOrder | Cancel Order |
|
|
8
9
|
| [**close**](DefaultApi.md#closeoperation) | **POST** /api/{exchange}/close | Close |
|
|
9
10
|
| [**createOrder**](DefaultApi.md#createorderoperation) | **POST** /api/{exchange}/createOrder | Create Order |
|
|
@@ -28,11 +29,82 @@ All URIs are relative to *http://localhost:3847*
|
|
|
28
29
|
| [**getExecutionPriceDetailed**](DefaultApi.md#getexecutionpricedetailedoperation) | **POST** /api/{exchange}/getExecutionPriceDetailed | Get Execution Price Detailed |
|
|
29
30
|
| [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
|
|
30
31
|
| [**loadMarkets**](DefaultApi.md#loadmarketsoperation) | **POST** /api/{exchange}/loadMarkets | Load Markets |
|
|
32
|
+
| [**submitOrder**](DefaultApi.md#submitorderoperation) | **POST** /api/{exchange}/submitOrder | Submit Order |
|
|
31
33
|
| [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book |
|
|
32
34
|
| [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades |
|
|
33
35
|
|
|
34
36
|
|
|
35
37
|
|
|
38
|
+
## buildOrder
|
|
39
|
+
|
|
40
|
+
> BuildOrder200Response buildOrder(exchange, buildOrderRequest)
|
|
41
|
+
|
|
42
|
+
Build Order
|
|
43
|
+
|
|
44
|
+
Build an order payload without submitting it to the exchange. Returns the exchange-native signed order or request body for inspection, forwarding through a middleware layer, or deferred submission via submitOrder().
|
|
45
|
+
|
|
46
|
+
### Example
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import {
|
|
50
|
+
Configuration,
|
|
51
|
+
DefaultApi,
|
|
52
|
+
} from 'pmxtjs';
|
|
53
|
+
import type { BuildOrderOperationRequest } from 'pmxtjs';
|
|
54
|
+
|
|
55
|
+
async function example() {
|
|
56
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
57
|
+
const api = new DefaultApi();
|
|
58
|
+
|
|
59
|
+
const body = {
|
|
60
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
61
|
+
exchange: exchange_example,
|
|
62
|
+
// BuildOrderRequest (optional)
|
|
63
|
+
buildOrderRequest: ...,
|
|
64
|
+
} satisfies BuildOrderOperationRequest;
|
|
65
|
+
|
|
66
|
+
try {
|
|
67
|
+
const data = await api.buildOrder(body);
|
|
68
|
+
console.log(data);
|
|
69
|
+
} catch (error) {
|
|
70
|
+
console.error(error);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// Run the test
|
|
75
|
+
example().catch(console.error);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description | Notes |
|
|
82
|
+
|------------- | ------------- | ------------- | -------------|
|
|
83
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
84
|
+
| **buildOrderRequest** | [BuildOrderRequest](BuildOrderRequest.md) | | [Optional] |
|
|
85
|
+
|
|
86
|
+
### Return type
|
|
87
|
+
|
|
88
|
+
[**BuildOrder200Response**](BuildOrder200Response.md)
|
|
89
|
+
|
|
90
|
+
### Authorization
|
|
91
|
+
|
|
92
|
+
No authorization required
|
|
93
|
+
|
|
94
|
+
### HTTP request headers
|
|
95
|
+
|
|
96
|
+
- **Content-Type**: `application/json`
|
|
97
|
+
- **Accept**: `application/json`
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### HTTP response details
|
|
101
|
+
| Status code | Description | Response headers |
|
|
102
|
+
|-------------|-------------|------------------|
|
|
103
|
+
| **200** | Build Order response | - |
|
|
104
|
+
|
|
105
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
106
|
+
|
|
107
|
+
|
|
36
108
|
## cancelOrder
|
|
37
109
|
|
|
38
110
|
> CreateOrder200Response cancelOrder(exchange, cancelOrderRequest)
|
|
@@ -1694,6 +1766,76 @@ No authorization required
|
|
|
1694
1766
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1695
1767
|
|
|
1696
1768
|
|
|
1769
|
+
## submitOrder
|
|
1770
|
+
|
|
1771
|
+
> CreateOrder200Response submitOrder(exchange, submitOrderRequest)
|
|
1772
|
+
|
|
1773
|
+
Submit Order
|
|
1774
|
+
|
|
1775
|
+
Submit a pre-built order returned by buildOrder().
|
|
1776
|
+
|
|
1777
|
+
### Example
|
|
1778
|
+
|
|
1779
|
+
```ts
|
|
1780
|
+
import {
|
|
1781
|
+
Configuration,
|
|
1782
|
+
DefaultApi,
|
|
1783
|
+
} from 'pmxtjs';
|
|
1784
|
+
import type { SubmitOrderOperationRequest } from 'pmxtjs';
|
|
1785
|
+
|
|
1786
|
+
async function example() {
|
|
1787
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
1788
|
+
const api = new DefaultApi();
|
|
1789
|
+
|
|
1790
|
+
const body = {
|
|
1791
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1792
|
+
exchange: exchange_example,
|
|
1793
|
+
// SubmitOrderRequest (optional)
|
|
1794
|
+
submitOrderRequest: ...,
|
|
1795
|
+
} satisfies SubmitOrderOperationRequest;
|
|
1796
|
+
|
|
1797
|
+
try {
|
|
1798
|
+
const data = await api.submitOrder(body);
|
|
1799
|
+
console.log(data);
|
|
1800
|
+
} catch (error) {
|
|
1801
|
+
console.error(error);
|
|
1802
|
+
}
|
|
1803
|
+
}
|
|
1804
|
+
|
|
1805
|
+
// Run the test
|
|
1806
|
+
example().catch(console.error);
|
|
1807
|
+
```
|
|
1808
|
+
|
|
1809
|
+
### Parameters
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
| Name | Type | Description | Notes |
|
|
1813
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1814
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1815
|
+
| **submitOrderRequest** | [SubmitOrderRequest](SubmitOrderRequest.md) | | [Optional] |
|
|
1816
|
+
|
|
1817
|
+
### Return type
|
|
1818
|
+
|
|
1819
|
+
[**CreateOrder200Response**](CreateOrder200Response.md)
|
|
1820
|
+
|
|
1821
|
+
### Authorization
|
|
1822
|
+
|
|
1823
|
+
No authorization required
|
|
1824
|
+
|
|
1825
|
+
### HTTP request headers
|
|
1826
|
+
|
|
1827
|
+
- **Content-Type**: `application/json`
|
|
1828
|
+
- **Accept**: `application/json`
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
### HTTP response details
|
|
1832
|
+
| Status code | Description | Response headers |
|
|
1833
|
+
|-------------|-------------|------------------|
|
|
1834
|
+
| **200** | Submit Order response | - |
|
|
1835
|
+
|
|
1836
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1837
|
+
|
|
1838
|
+
|
|
1697
1839
|
## watchOrderBook
|
|
1698
1840
|
|
|
1699
1841
|
> FetchOrderBook200Response watchOrderBook(exchange, watchOrderBookRequest)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# SubmitOrderRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`args` | [Array<BuiltOrder>](BuiltOrder.md)
|
|
10
|
+
`credentials` | [ExchangeCredentials](ExchangeCredentials.md)
|
|
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
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|