edgeX

https://edgex-1.gitbook.io/edgeX-documentation
Admin
edgeX is an Ethereum Layer-2 blockchain providing a high-performance on-chain trading infrastructure...
Tokens:162,368
Snippets:410
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### GET Account Asset API Response Example (JSON)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

This JSON object represents a successful response from the 'GET Account Asset' API. It includes status information, account details, trading settings, and timestamps. The structure is designed to provide comprehensive information about a user's account.

```json
{
    "code": "SUCCESS",
    "data": {
        "id": "543429922991899150",
        "userId": "543429922866069763",
        "ethAddress": "0x1fB51aa234287C3CA1F957eA9AD0E148Bb814b7A",
        "l2Key": "0x5580341e2c99823a0a35356b8ac84e372dd38fd1f4b50f607b931ec8038c211",
        "l2KeyYCoordinate": "0x6ea3dd81a7fc864893c8c6f674e4a4510c369f939bdc0259a0980dfde882c2d",
        "clientAccountId": "main",
        "isSystemAccount": false,
        "defaultTradeSetting": {
            "isSetFeeRate": true,
            "takerFeeRate": "0.000500",
            "makerFeeRate": "0.000180",
            "isSetFeeDiscount": false,
            "takerFeeDiscount": "0",
            "makerFeeDiscount": "0",
            "isSetMaxLeverage": false,
            "maxLeverage": "0"
        },
        "contractIdToTradeSetting": {
            "10000001": {
                "isSetFeeRate": false,
                "takerFeeRate": "",
                "makerFeeRate": "",
                "isSetFeeDiscount": false,
                "takerFeeDiscount": "",
                "makerFeeDiscount": "",
                "isSetMaxLeverage": true,
                "maxLeverage": "50"
            }
        },
        "maxLeverageLimit": "0",
        "createOrderPerMinuteLimit": 0,
        "createOrderDelayMillis": 0,
        "extraType": "",
        "extraDataJson": "",
        "status": "NORMAL",
        "isLiquidating": false,
        "createdTime": "1730204434094",
        "updatedTime": "1733993378059"
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734664605752",
    "responseTime": "1734664605760",
    "traceId": "c7be70afbf00d7f879d2809e0f042dfe"
}
```

--------------------------------

### Get Account Data Response Example (JSON)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

This JSON structure represents a successful response when fetching account data. It includes details about the user's account, collateral, and positions. The response is typically returned in a 200 OK status.

```json
{
    "code": "SUCCESS",
    "data": {
        "account": {
            "id": "543429922991899150",
            "userId": "543429922866069763",
            "ethAddress": "0x1fB51aa234287C3CA1F957eA9AD0E148Bb814b7A",
            "l2Key": "0x5580341e2c99823a0a35356b8ac84e372dd38fd1f4b50f607b931ec8038c211",
            "l2KeyYCoordinate": "0x6ea3dd81a7fc864893c8c6f674e4a4510c369f939bdc0259a0980dfde882c2d",
            "clientAccountId": "main",
            "isSystemAccount": false,
            "defaultTradeSetting": {
                "isSetFeeRate": true,
                "takerFeeRate": "0.000500",
                "makerFeeRate": "0.000180",
                "isSetFeeDiscount": false,
                "takerFeeDiscount": "0",
                "makerFeeDiscount": "0",
                "isSetMaxLeverage": false,
                "maxLeverage": "0"
            },
            "contractIdToTradeSetting": {
                "10000001": {
                    "isSetFeeRate": false,
                    "takerFeeRate": "",
                    "makerFeeRate": "",
                    "isSetFeeDiscount": false,
                    "takerFeeDiscount": "",
                    "makerFeeDiscount": "",
                    "isSetMaxLeverage": true,
                    "maxLeverage": "50"
                }
            },
            "maxLeverageLimit": "0",
            "createOrderPerMinuteLimit": 0,
            "createOrderDelayMillis": 0,
            "extraType": "",
            "extraDataJson": "",
            "status": "NORMAL",
            "isLiquidating": false,
            "createdTime": "1730204434094",
            "updatedTime": "1733993378059"
        },
        "collateralList": [
            {
                "userId": "543429922866069763",
                "accountId": "543429922991899150",
                "coinId": "1000",
                "amount": "-81.943188",
                "legacyAmount": "15.501312",
                "cumDepositAmount": "70.000000",
                "cumWithdrawAmount": "0",
                "cumTransferInAmount": "0",
                "cumTransferOutAmount": "-55.000000",
                "cumPositionBuyAmount": "-388.4645",
                "cumPositionSellAmount": "291.7367",
                "cumFillFeeAmount": "-0.215388",
                "cumFundingFeeAmount": "0",
                "cumFillFeeIncomeAmount": "0",
                "createdTime": "1730204434094",
                "updatedTime": "1734663352066"
            }
        ],
        "positionList": [
            {
                "userId": "543429922866069763",
                "accountId": "543429922991899150",
                "coinId": "1000",
                "contractId": "10000001",
                "openSize": "0.001",
                "openValue": "97.444500",
                "openFee": "-0.017540",
                "fundingFee": "0.000000",
                "longTermCount": 3,
                "longTermStat": {
                    "cumOpenSize": "0.001",
                    "cumOpenValue": "97.444500",
                    "cumOpenFee": "-0.017540",
                    "cumCloseSize": "0",
                    "cumCloseValue": "0",
                    "cumCloseFee": "0",
                    "cumFundingFee": "0",
                    "cumLiquidateFee": "0"
                },
                "longTermCreatedTime": "1734662617992",
                "longTermUpdatedTime": "1734662617992",
                "shortTermCount": 0,
                "shortTermStat": {
                    "cumOpenSize": "0",
                    "cumOpenValue": "0",
                    "cumOpenFee": "0",
                    "cumCloseSize": "0",
                    "cumCloseValue": "0",
                    "cumCloseFee": "0",
                    "cumFundingFee": "0",
                    "cumLiquidateFee": "0"
                },
                "shortTermCreatedTime": "0",
                "shortTermUpdatedTime": "0",
                "longTotalStat": {
                    "cumOpenSize": "0.004",
                    "cumOpenValue": "388.464500",
                    "cumOpenFee": "-0.131882",
                    "cumCloseSize": "-0.003",
                    "cumCloseValue": "-291.736700",
                    "cumCloseFee": "-0.083506",
                    "cumFundingFee": "0",
                    "cumLiquidateFee": "0"
                },
                "shortTotalStat": {
                    "cumOpenSize": "0",
                    "cumOpenValue": "0",
                    "cumOpenFee": "0",
                    "cumCloseSize": "0",
                    "cumCloseValue": "0",
                    "cumCloseFee": "0",
                    "cumFundingFee": "0",
                    "cumLiquidateFee": "0"
                }
            }
        ]
    }
}
```

--------------------------------

### Get Kline Data Request Example

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/public-api/quote-api

An example URL for fetching kline data from the Edgex API. It includes parameters such as contractId, klineType, time filters, and priceType.

```HTTP
https://pro.edgex.exchange/api/v1/public/quote/getKline?contractId=10000002&klineType=HOUR_1&filterBeginKlineTimeInclusive=1733416860000&filterEndKlineTimeExclusive=1734601200000&priceType=LAST_PRICE
```

--------------------------------

### GET Account Page by User ID API Response Example (JSON)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

This JSON object represents a successful response from the GET /api/v1/private/account/getAccountPage endpoint. It includes account details, pagination information, and timestamps. The 'dataList' array contains individual account objects, each with a 'defaultTradeSetting' and 'contractIdToTradeSetting'.

```json
{
    "code": "SUCCESS",
    "data": {
        "dataList": [
            {
                "id": "543429922991899150",
                "userId": "543429922866069763",
                "ethAddress": "0x1fB51aa234287C3CA1F957eA9AD0E148Bb814b7A",
                "l2Key": "0x5580341e2c99823a0a35356b8ac84e372dd38fd1f4b50f607b931ec8038c211",
                "l2KeyYCoordinate": "0x6ea3dd81a7fc864893c8c6f674e4a4510c369f939bdc0259a0980dfde882c2d",
                "clientAccountId": "main",
                "isSystemAccount": false,
                "defaultTradeSetting": {
                    "isSetFeeRate": true,
                    "takerFeeRate": "0.000500",
                    "makerFeeRate": "0.000180",
                    "isSetFeeDiscount": false,
                    "takerFeeDiscount": "0",
                    "makerFeeDiscount": "0",
                    "isSetMaxLeverage": false,
                    "maxLeverage": "0"
                },
                "contractIdToTradeSetting": {
                    "10000001": {
                        "isSetFeeRate": false,
                        "takerFeeRate": "",
                        "makerFeeRate": "",
                        "isSetFeeDiscount": false,
                        "takerFeeDiscount": "",
                        "makerFeeDiscount": "",
                        "isSetMaxLeverage": true,
                        "maxLeverage": "50"
                    }
                },
                "maxLeverageLimit": "0",
                "createOrderPerMinuteLimit": 0,
                "createOrderDelayMillis": 0,
                "extraType": "",
                "extraDataJson": "",
                "status": "NORMAL",
                "isLiquidating": false,
                "createdTime": "1730204434094",
                "updatedTime": "1733993378059"
            }
        ],
        "nextPageOffsetData": "551109015904453258"
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734661416005",
    "responseTime": "1734661416008",
    "traceId": "dc6a8442169c8cdb831ceb15c812b7fc"
}
```

--------------------------------

### Get Server Time - JSON Response Example

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/public-api/metadata-api

This snippet shows an example JSON response from the GET /api/v1/public/meta/getServerTime endpoint. It includes the server's time in milliseconds, along with other metadata like status code, message, and trace ID. This endpoint has no input parameters.

```json
{
    "code": "SUCCESS",
    "data": {
        "timeMillis": "1734596189305"
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734596189305",
    "responseTime": "1734596189305",
    "traceId": "a69e6ec51701d7246cb344a719c99cbf"
}
```

--------------------------------

### POST /api/v1/tradesetting

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

Sets various trading parameters including fee rates, fee discounts, and maximum leverage for the user's account.

```APIDOC
## POST /api/v1/tradesetting

### Description
Sets various trading parameters including fee rates, fee discounts, and maximum leverage for the user's account.

### Method
POST

### Endpoint
/api/v1/tradesetting

### Parameters
#### Request Body
- **isSetFeeRate** (boolean) - Optional - Whether Fee Rate is Set. Whether to set a specific fee rate value.
- **takerFeeRate** (string(decimal)) - Optional - Taker Fee Rate. Taker fee rate, range [0, 1), valid only when is_set_fee_rate=true.
- **makerFeeRate** (string(decimal)) - Optional - Maker Fee Rate. Maker fee rate, range [0, 1), valid only when is_set_fee_rate=true.
- **isSetFeeDiscount** (boolean) - Optional - Whether Fee Discount is Set. Whether to set a fee discount.
- **takerFeeDiscount** (string(decimal)) - Optional - Taker Fee Discount. Taker fee discount, range [0, 1), valid only when is_set_fee_discount=true.
- **makerFeeDiscount** (string(decimal)) - Optional - Maker Fee Discount. Maker fee discount, range [0, 1), valid only when is_set_fee_discount=true.
- **isSetMaxLeverage** (boolean) - Optional - Whether Maximum Leverage is Set. Whether to set maximum trading leverage.
- **maxLeverage** (string(decimal)) - Optional - Maximum Leverage. Maximum trading leverage.

### Request Example
```json
{
  "isSetFeeRate": true,
  "takerFeeRate": "0.001",
  "makerFeeRate": "0.0005",
  "isSetFeeDiscount": true,
  "takerFeeDiscount": "0.0001",
  "makerFeeDiscount": "0.00005",
  "isSetMaxLeverage": true,
  "maxLeverage": "100.0"
}
```

### Response
#### Success Response (200)
- **code** (string) - Status Code. Returns "SUCCESS" on success; otherwise, it indicates failure.
- **data** (object) - Account Information. Account information data.
- **errorParam** (object) - Error Parameters. Error message parameter information
- **requestTime** (string(timestamp)) - Server Request Time. Time at which the server received the request
- **responseTime** (string(timestamp)) - Server Response Time. Time at which the server sent the response
- **traceId** (string) - Trace ID. Invocation trace ID

#### Response Example
```json
{
  "code": "SUCCESS",
  "data": {},
  "errorParam": {},
  "requestTime": "2023-10-27T10:00:00Z",
  "responseTime": "2023-10-27T10:00:01Z",
  "traceId": "abc123xyz789"
}
```
```

--------------------------------

### GET Active Withdrawals with Pagination (JSON Response Example)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/withdraw-api

This snippet shows an example JSON response for the GET /api/v1/private/withdraw/getActiveWithdraw endpoint. It includes a list of active withdrawals, each with detailed information such as ID, account details, coin information, transaction details, and status. The response also contains pagination information.

```json
{
    "code": "SUCCESS",
    "data": {
        "dataList": [
            {
                "id": "563516408235819790",
                "userId": "543429922866069763",
                "accountId": "543429922991899150",
                "coinId": "1000",
                "amount": "10.000000",
                "ethAddress": "0x1fB51aa234287C3CA1F957eA9AD0E148Bb814b7A",
                "erc20Address": "0x...",
                "clientWithdrawId": "client_withdraw_123",
                "riskSignature": {
                    "r": "0x...",
                    "s": "0x...",
                    "v": "0x..."
                },
                "l2Nonce": "123456789",
                "l2ExpireTime": "1734352781355",
                "l2Signature": {
                    "r": "0x...",
                    "s": "0x...",
                    "v": "0x..."
                },
                "extraType": "",
                "extraDataJson": "",
                "status": "SUCCESS_L2_APPROVED",
                "collateralTransactionId": "563516408265179918",
                "censorTxId": "830852",
                "censorTime": "1734352781355",
                "censorFailCode": "",
                "censorFailReason": "",
                "l2TxId": "1022403",
                "l2RejectTime": "0",
                "l2RejectCode": "",
                "l2RejectReason": "",
                "l2ApprovedTime": "1734353551654",
                "createdTime": "1734352781355",
                "updatedTime": "1734353551715"
            }
        ],
        "nextPageOffsetData": ""
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734664486740",
    "responseTime": "1734664486761",
    "traceId": "b3086f53c2d4503f6a4790b80f0e534b"
}
```

--------------------------------

### POST /createorder

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/order-api

Allows users to create a new order by specifying detailed parameters for the order.

```APIDOC
## POST /createorder

### Description
Allows users to create a new order by specifying detailed parameters for the order. This includes order type, quantity, price, and associated account and contract information.

### Method
POST

### Endpoint
/createorder

### Parameters
#### Request Body
- **accountId** (string(int64)) - Optional - Account ID.
- **contractId** (string(int64)) - Optional - Contract ID.
- **side** (string) - Optional - Buy/sell direction. This field is required.
- **size** (string) - Optional - Order quantity. Actual type is decimal. This field is required.
- **price** (string) - Optional - Order price (worst acceptable price). Actual type is decimal. This field is required, enter 0 for market orders.
- **clientOrderId** (string) - Optional - Client-defined ID for idempotency checks. This field is required.
- **type** (string) - Optional - Order type. This field is required.
- **timeInForce** (string) - Optional - Order execution policy. Relevant when `type` is `LIMIT`/`STOP_LIMIT`/`TAKE_PROFIT_LIMIT`. This field is required, and should be `IMMEDIATE_OR_CANCEL` for market orders.
- **reduceOnly** (boolean) - Optional - Whether this is a reduce-only order. This field is required.
- **triggerPrice** (string) - Optional - Trigger price. Relevant when `type` is `STOP_LIMIT`/`STOP_MARKET`/`TAKE_PROFIT_LIMIT`/`TAKE_PROFIT_MARKET`. If 0, the field is empty. Actual type is decimal. Required for conditional orders.
- **triggerPriceType** (string) - Optional - Price type: Last price, Mark price, etc. Relevant when the order is conditional. Required for conditional orders.
- **expireTime** (string(int64)) - Optional - Expiration time.

### Request Example
```json
{
  "accountId": "123456",
  "contractId": "789012",
  "side": "BUY",
  "size": "10.5",
  "price": "100.00",
  "clientOrderId": "my_unique_id_123",
  "type": "LIMIT",
  "timeInForce": "GOOD_TILL_CANCELLED",
  "reduceOnly": false,
  "triggerPrice": "0",
  "triggerPriceType": "",
  "expireTime": "1678886400"
}
```

### Response
#### Success Response (200)
(Response details not provided in the input text)

#### Response Example
(Response details not provided in the input text)
```

--------------------------------

### Account Configuration

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

This section details the fields available for account configuration, including order limits, creation delays, extra type and data, status, liquidation status, and timestamps.

```APIDOC
## Account Configuration Details

### Description
Provides details about the configurable parameters for an account.

### Parameters
#### Request Body Fields (for PUT/POST operations)
- **createOrderPerMinuteLimit** (integer) - Optional - Order frequency limit per minute. If 0, default limit is used; if < 0, no limit is applied.
- **createOrderDelayMillis** (integer) - Optional - Order delay milliseconds, must be greater than or equal to 0.
- **extraType** (string) - Optional - Extra type for upper-layer use.
- **extraDataJson** (string) - Optional - Extra data in JSON format, default is an empty string.
- **status** (string) - Optional - Account status. Enumerated values: UNKNOWN_ACCOUNT_STATUS, CENSORING, NORMAL, DISABLED, INVALID, UNRECOGNIZED.
- **isLiquidating** (boolean) - Optional - Whether the account is being liquidated.
- **createdTime** (string/int64) - Read-only - Creation time.
- **updatedTime** (string/int64) - Read-only - Update time.

### Enumerated Values for Status
- UNKNOWN_ACCOUNT_STATUS
- CENSORING
- NORMAL
- DISABLED
- INVALID
- UNRECOGNIZED
```

--------------------------------

### GET Account Deleverage Light API Response Example (JSON)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/account-api

This JSON response from the GET /api/v1/private/account/getAccountDeleverageLight endpoint indicates the deleverage status for accounts. The 'positionContractIdToLightNumberMap' object maps contract IDs to their respective deleverage light numbers. This response is typically returned with a 'SUCCESS' code and null message.

```json
{
    "code": "SUCCESS",
    "data": {
        "positionContractIdToLightNumberMap": {
            "10000001": 3
        }
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734661307929",
    "responseTime": "1734661307935",
    "traceId": "202ee8ba15ab633b68a35a8bc9756952"
}
```

--------------------------------

### POST /api/v1/private/order/createOrder

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/order-api

Creates a new order with specified details, including price, size, type, and other parameters.

```APIDOC
## POST /api/v1/private/order/createOrder

### Description
Creates a new order with specified details, including price, size, type, and other parameters. Special guidelines apply for market orders regarding `l2Value`, `l2LimitFee`, and `l2Value` to prevent validation failures.

### Method
POST

### Endpoint
/api/v1/private/order/createOrder

### Parameters
#### Request Body
- **price** (string) - Required - The price of the order.
- **size** (string) - Required - The size of the order.
- **type** (string) - Required - The type of order (e.g., "LIMIT").
- **timeInForce** (string) - Required - The time in force for the order (e.g., "GOOD_TIL_CANCEL").
- **reduceOnly** (boolean) - Optional - Whether the order is reduce only.
- **isPositionTpsl** (boolean) - Optional - Whether to set take profit/stop loss for the position.
- **isSetOpenTp** (boolean) - Optional - Whether to set open take profit.
- **isSetOpenSl** (boolean) - Optional - Whether to set open stop loss.
- **accountId** (string) - Required - The ID of the account.
- **contractId** (string) - Required - The ID of the contract.
- **side** (string) - Required - The side of the order (e.g., "BUY").
- **triggerPrice** (string) - Optional - The trigger price for stop orders.
- **triggerPriceType** (string) - Optional - The type of trigger price (e.g., "LAST_PRICE").
- **clientOrderId** (string) - Optional - A unique client-defined order ID.
- **expireTime** (string) - Optional - The expiration time of the order.
- **l2Nonce** (string) - Required for some order types - Nonce value for L2 protocol.
- **l2Value** (string) - Required for some order types - Validation value for L2 protocol. Guidelines apply for market orders.
- **l2Size** (string) - Required for some order types - Size value for L2 protocol.
- **l2LimitFee** (string) - Required for some order types - Limit fee for L2 protocol. Guidelines apply for fee calculation.
- **l2ExpireTime** (string) - Optional - Expiration time for L2 protocol.
- **l2Signature** (string) - Required for some order types - Signature for L2 protocol.
- **extraType** (string) - Optional - Extra order type information.
- **extraDataJson** (string) - Optional - Additional JSON data.
- **symbol** (string) - Required - The trading symbol (e.g., "BTCUSDT").
- **showEqualValInput** (boolean) - Optional - Whether to show equal value input.
- **maxSellQTY** (number) - Optional - Maximum sell quantity.
- **maxBuyQTY** (number) - Optional - Maximum buy quantity.

**Market Order Parameter Guidelines:**
* **For Buy Orders:** `l2Value = oracle_price × 10 × size` (set a higher value for sufficient coverage)
* **For Sell Orders:** `l2Value = tickSize` (use the minimum tick size value)
* **For Fee Calculation:** `l2LimitFee = Ceil(value × fee_rate) × 10^6`

**Important Notes:**
* `l2Value` is for validation purposes only, not execution value.
* `l2LimitFee` is for validation purposes only, not actual transaction fee.
* Setting these values too low may cause signature validation to fail.
* It is recommended to set slightly higher values to ensure successful order placement.

### Request Example
```json
{
    "price": "97393.8",
    "size": "0.001",
    "type": "LIMIT",
    "timeInForce": "GOOD_TIL_CANCEL",
    "reduceOnly": false,
    "isPositionTpsl": false,
    "isSetOpenTp": false,
    "isSetOpenSl": false,
    "accountId": "543429922991899150",
    "contractId": "10000001",
    "side": "BUY",
    "triggerPrice": "",
    "triggerPriceType": "LAST_PRICE",
    "clientOrderId": "21163368294502694",
    "expireTime": "1736476772359",
    "l2Nonce": "808219",
    "l2Value": "97.3938",
    "l2Size": "0.001",
    "l2LimitFee": "0.048697",
    "l2ExpireTime": "1737254372359",
    "l2Signature": "0537b3051bb9ffb98bb842ff6cadf69807a8dbf74f94d8c6106cf4f59b1fd2dc01aa2d93420408d60298831ddb82f7b482574ecb0fc285294dfeec732379ec40",
    "extraType": "",
    "extraDataJson": "",
    "symbol": "BTCUSDT",
    "showEqualValInput": true,
    "maxSellQTY": 0.009,
    "maxBuyQTY": 0.007
}
```

### Response
#### Success Response (200)
- **code** (string) - Response code.
- **data** (object) - Contains order creation information.
  - **orderId** (string) - The ID of the created order.
- **msg** (string) - Response message (null if successful).
- **errorParam** (string) - Parameter with error (null if successful).
- **requestTime** (string) - Timestamp of the request.
- **responseTime** (string) - Timestamp of the response.
- **traceId** (string) - Unique trace ID for the request.

#### Response Example
```json
{
    "code": "SUCCESS",
    "data": {
        "orderId": "564814927928230158"
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734662372560",
    "responseTime": "1734662372575",
    "traceId": "364c0020d1fe90bbfcca3cf3a9d54759"
}
```
```

--------------------------------

### Create Order (JSON)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/order-api

Creates a new order with specified parameters. Supports limit and market orders with options for time in force, position management, and client-defined IDs. Includes detailed guidelines for market order parameters and fee calculations, noting that l2Value and l2LimitFee are for validation only.

```json
{
    "price": "97393.8",
    "size": "0.001",
    "type": "LIMIT",
    "timeInForce": "GOOD_TIL_CANCEL",
    "reduceOnly": false,
    "isPositionTpsl": false,
    "isSetOpenTp": false,
    "isSetOpenSl": false,
    "accountId": "543429922991899150",
    "contractId": "10000001",
    "side": "BUY",
    "triggerPrice": "",
    "triggerPriceType": "LAST_PRICE",
    "clientOrderId": "21163368294502694",
    "expireTime": "1736476772359",
    "l2Nonce": "808219",
    "l2Value": "97.3938",
    "l2Size": "0.001",
    "l2LimitFee": "0.048697",
    "l2ExpireTime": "1737254372359",
    "l2Signature": "0537b3051bb9ffb98bb842ff6cadf69807a8dbf74f94d8c6106cf4f59b1fd2dc01aa2d93420408d60298831ddb82f7b482574ecb0fc285294dfeec732379ec40",
    "extraType": "",
    "extraDataJson": "",
    "symbol": "BTCUSDT",
    "showEqualValInput": true,
    "maxSellQTY": 0.009,
    "maxBuyQTY": 0.007
}
```

--------------------------------

### Private API Authentication with CURL

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/authentication

This example demonstrates how to make a GET request to a private API endpoint using cURL, including the necessary authentication headers for signature and timestamp.

```curl
curl --location --request GET 'https://pro.edgex.exchange/api/v1/private/account/getPositionTransactionPage?filterTypeList=SETTLE_FUNDING_FEE&size=10&accountId=544159487963955214' \
--header 'X-edgeX-Api-Signature: 06d28020763542c0afc296dc8743797c6fda8ea9727745b57b671f70326dfed6077cd******************************aff3162e39d05d9df1c3ddf9648650382d6e62ff1076b14c0e6c687088d3917d8490e5412a080a6e9ea940c720ddd' \
--header 'X-edgeX-Api-Timestamp: 1736313025024'
```

--------------------------------

### Order Parameters

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/order-api

This section outlines the parameters available for order placement, focusing on details for off-exchange orders, leverage, fee rates, and L2 signatures.

```APIDOC
## Order Parameters

### Description
Provides details on various parameters that can be included when placing an order, such as off-exchange fill values, leverage settings, fee rates, and specific L2 signature parameters.

### Parameters
#### Request Body Parameters

- **withoutMatchFillValue** (string) - Optional - Off-exchange fill value (valid only when `is_without_match` is true).
- **withoutMatchPeerAccountId** (string(int64)) - Optional - Off-exchange counterparty account ID (valid only when `is_without_match` is true).
- **withoutMatchPeerOrderId** (string(int64)) - Optional - Off-exchange counterparty order ID (valid only when `is_without_match` is true).
- **maxLeverage** (string) - Optional - Leverage used when placing the order. Actual type is decimal.
- **takerFeeRate** (string) - Optional - Taker fee rate when placing the order. Actual type is decimal.
- **makerFeeRate** (string) - Optional - Maker fee rate when placing the order. Actual type is decimal.
- **liquidateFeeRate** (string) - Optional - Liquidation fee rate when placing the order. Actual type is decimal.
- **marketLimitPrice** (string) - Optional - Limit price for submitting market orders to the matching engine (only exists for market orders, 0 otherwise). Actual type is decimal.
- **marketLimitValue** (string) - Optional - Limit value for submitting market orders to the matching engine (only exists for market orders, 0 otherwise). Actual type is decimal.
- **l2Nonce** (string(int64)) - Optional - L2 signature nonce. Takes the first 32 bits of sha256(`client_order_id`).
- **l2Value** (string) - Optional - L2 signature order value (the actual filled price must be equal to or better than `l2_value` / `l2_size`). May differ from `price` x `size`. Actual type is decimal.
- **l2Size** (string) - Optional - L2 signature order quantity. May differ from the `size` field. Actual type is decimal.
- **l2LimitFee** (string) - Optional - Maximum acceptable fee for L2 signature.
- **l2ExpireTime** (string(int64)) - Optional - L2 signature expiration time in milliseconds. The hour value should be used when generating/verifying the signature, i.e. `l2_expire_time` / 3600000. Note that this value must be greater or equal to `expire_time` + 8 * 24 * 60 * 60 * 1000 (8 days).

### Request Example
```json
{
  "withoutMatchFillValue": "1000000",
  "withoutMatchPeerAccountId": "123456789",
  "maxLeverage": "10",
  "takerFeeRate": "0.0005",
  "makerFeeRate": "0.0002",
  "liquidateFeeRate": "0.001",
  "marketLimitPrice": "100.50",
  "l2Nonce": "1678886400000",
  "l2Value": "100500000",
  "l2Size": "1000000",
  "l2LimitFee": "500",
  "l2ExpireTime": "1710547200000"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the order parameters are accepted.
```

--------------------------------

### JSON Response Example for Get Orders by Client Order IDs (Batch)

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/private-api/order-api

This JSON snippet illustrates a successful response from the Get Orders by Client Order IDs (Batch) API endpoint. It includes a status code, order data, and other metadata. The 'data' field contains an array of order objects, each with detailed information like IDs, prices, sizes, and status.

```json
{
    "code": "SUCCESS",
    "data": [
        {
            "id": "564829588270612618",
            "userId": "543429922866069763",
            "accountId": "551109015904453258",
            "coinId": "1000",
            "contractId": "10000001",
            "side": "BUY",
            "price": "96260.7",
            "size": "0.001",
            "clientOrderId": "9311381563209122",
            "type": "LIMIT",
            "timeInForce": "GOOD_TIL_CANCEL",
            "reduceOnly": false,
            "triggerPrice": "0",
            "triggerPriceType": "UNKNOWN_PRICE_TYPE",
            "expireTime": "1736480267612",
            "sourceKey": "",
            "isPositionTpsl": false,
            "isLiquidate": false,
            "isDeleverage": false,
            "openTpslParentOrderId": "0",
            "isSetOpenTp": false,
            "openTp": {
                "side": "UNKNOWN_ORDER_SIDE",
                "price": "",
                "size": "",
                "clientOrderId": "",
                "triggerPrice": "",
                "triggerPriceType": "UNKNOWN_PRICE_TYPE",
                "expireTime": "0",
                "l2Nonce": "0",
                "l2Value": "",
                "l2Size": "",
                "l2LimitFee": "",
                "l2ExpireTime": "0",
                "l2Signature": {
                    "r": "",
                    "s": "",
                    "v": ""
                }
            },
            "isSetOpenSl": false,
            "openSl": {
                "side": "UNKNOWN_ORDER_SIDE",
                "price": "",
                "size": "",
                "clientOrderId": "",
                "triggerPrice": "",
                "triggerPriceType": "UNKNOWN_PRICE_TYPE",
                "expireTime": "0",
                "l2Nonce": "0",
                "l2Value": "",
                "l2Size": "",
                "l2LimitFee": "",
                "l2ExpireTime": "0",
                "l2Signature": {
                    "r": "",
                    "s": "",
                    "v": ""
                }
            },
            "isWithoutMatch": false,
            "withoutMatchFillSize": "0",
            "withoutMatchFillValue": "0",
            "withoutMatchPeerAccountId": "0",
            "withoutMatchPeerOrderId": "0",
            "maxLeverage": "50",
            "takerFeeRate": "0.000500",
            "makerFeeRate": "0.000180",
            "liquidateFeeRate": "0.01",
            "marketLimitPrice": "0",
            "marketLimitValue": "0",
            "l2Nonce": "3353661024",
            "l2Value": "96.260700",
            "l2Size": "0.001",
            "l2LimitFee": "0.048131",
            "l2ExpireTime": "1737257867612",
            "l2Signature": {
                "r": "0x072f299b86c199e161508ed554889d50476bc96d5a0c320bcd5b7e579b692c06",
                "s": "0x05b24b988f84bca951b3bb4e69b11e0aa1ce08cca38fea0f3afd94b5e7cd09f8",
                "v": ""
            },
            "extraType": "",
            "extraDataJson": "",
            "status": "OPEN",
            "matchSequenceId": "35229771",
            "triggerTime": "0",
            "triggerPriceTime": "0",
            "triggerPriceValue": "0",
            "cancelReason": "UNKNOWN_ORDER_CANCEL_REASON",
            "cumFillSize": "0",
            "cumFillValue": "0",
            "cumFillFee": "0",
            "maxFillPrice": "0",
            "minFillPrice": "0",
            "cumLiquidateFee": "0",
            "cumRealizePnl": "0",
            "cumMatchSize": "0",
            "cumMatchValue": "0",
            "cumMatchFee": "0",
            "cumFailSize": "0",
            "cumFailValue": "0",
            "cumFailFee": "0",
            "cumApprovedSize": "0",
            "cumApprovedValue": "0",
            "cumApprovedFee": "0",
            "createdTime": "1734665867870",
            "updatedTime": "1734665867876"
        }
    ],
    "msg": null,
    "errorParam": null,
    "requestTime": "1734665901264",
    "responseTime": "1734665901281",
    "traceId": "65ca2097b4d9cfb487bd9cef53097040"
}
```

--------------------------------

### Trading Pair Configuration Parameters

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/public-api/metadata-api

This section outlines the various parameters that can be configured for a trading pair. These include settings related to funding rates, display options, and StarkEx specific configurations.

```APIDOC
## Trading Pair Configuration Parameters

### Description
This section details the configurable parameters for trading pairs. Each parameter has a name, type, default value, and a description of its purpose.

### Parameters
#### Request Body Parameters
- **fundingInterestRate** (string(decimal)) - Optional - Default value of overall interest rate, e.g., 0.0003
- **fundingImpactMarginNotional** (string(decimal)) - Optional - Quantity for calculating depth-weighted bid/ask price, e.g., 8000
- **fundingMaxRate** (string(decimal)) - Optional - Maximum funding rate, e.g., 0.000234
- **fundingMinRate** (string(decimal)) - Optional - Minimum funding rate, e.g., -0.000234
- **fundingRateIntervalMin** (string(decimal)) - Optional - Settlement interval of funding rate (in minutes, must be an integer multiple of 60 minutes, settlement starts from 00:00 UTC) decimal
- **displayDigitMerge** (string(decimal)) - Optional - Depth merge. e.g., "1,0.1,0.001"
- **displayMaxLeverage** (string(decimal)) - Optional - Maximum leverage multiplier to display, decimal. e.g., 20
- **displayMinLeverage** (string(decimal)) - Optional - Minimum leverage multiplier to display, decimal. e.g., 1
- **displayNewIcon** (boolean) - Optional - Whether it is a newly listed pair
- **displayHotIcon** (boolean) - Optional - Whether it is a hot pair
- **matchServerName** (string) - Optional - Matching service name, e.g., xxx-match-server-a. This value cannot be changed once configured, otherwise data migration is required.
- **starkExSyntheticAssetId** (string(int64)) - Optional - Synthetic asset id of the current pair, bigint for hex str.
- **starkExResolution** (string(int64)) - Optional - Processing precision of the quantity held by the current pair, bigint for hex str
- **starkExOraclePriceQuorum** (string(int64)) - Optional - Legal number of oracle prices, bigint for hex str
- **starkExOraclePriceSignedAssetId** (string) - Optional - bigint for hex str
- **starkExOraclePriceSigner** (string) - Optional - bigint for hex str

### Request Example
```json
{
  "fundingInterestRate": "0.0003",
  "fundingImpactMarginNotional": "8000",
  "fundingMaxRate": "0.000234",
  "fundingMinRate": "-0.000234",
  "fundingRateIntervalMin": "3600",
  "displayDigitMerge": "1,0.1,0.001",
  "displayMaxLeverage": "20",
  "displayMinLeverage": "1",
  "displayNewIcon": true,
  "displayHotIcon": false,
  "matchServerName": "xxx-match-server-a",
  "starkExSyntheticAssetId": "1234567890abcdef",
  "starkExResolution": "1000000000000000000",
  "starkExOraclePriceQuorum": "3",
  "starkExOraclePriceSignedAssetId": "1234567890abcdef",
  "starkExOraclePriceSigner": "abcdef1234567890"
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the pair configuration has been updated.

#### Response Example
```json
{
  "message": "Trading pair configuration updated successfully."
}
```
```

--------------------------------

### Get Exchange Long Short Ratio Response Example

Source: https://edgex-1.gitbook.io/edgeX-documentation/api/public-api/quote-api

A successful JSON response (HTTP 200) for retrieving the exchange long short ratio. It includes ratio data, available time ranges, and request metadata.

```JSON
{
    "code": "SUCCESS",
    "data": {
        "exchangeLongShortRatioList": [
            {
                "range": "30m",
                "contractId": "10000001",
                "exchange": "_total_",
                "buyRatio": "50.9900",
                "sellRatio": "49.0100",
                "buyVolUsd": "567855766.2701",
                "sellVolUsd": "545892952.7900",
                "createdTime": "1734597018839",
                "updatedTime": "1734597018839"
            }
        ],
        "allRangeList": [
            "30m",
            "1h",
            "4h",
            "12h",
            "24h"
        ]
    },
    "msg": null,
    "errorParam": null,
    "requestTime": "1734597836994",
    "responseTime": "1734597837001",
    "traceId": "60af97ec1357f9d00da50bada9e4364c"
}
```
Tokens:
Raw