IntentX Trading API

https://gw.intentx.io/api
Admin
An API for the IntentX trading platform, providing programmatic access to manage API keys, accounts,...
Tokens:5,665
Snippets:8
Trust Score:7.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Pricing

Source: https://gw.intentx.io/api/index

Endpoints for retrieving real-time pricing information.

```APIDOC
## GET /v1/pricing/mark-price/{symbol}

### Description
Get mark price for a symbol.

### Method
GET

### Endpoint
/v1/pricing/mark-price/{symbol}

### Parameters
#### Path Parameters
- **symbol** (string) - Required - The trading symbol (e.g., 'BTC-USD').

### Response
#### Success Response (200)
- **markPrice
```

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

### Tpsl

Source: https://gw.intentx.io/api/index

Endpoints for managing Take Profit and Stop Loss orders for positions.

```APIDOC
## POST /v1/tpsl/create

### Description
Create a new take profit / stop loss for a given position. Requires close and open permissions.

### Method
POST

### Endpoint
/v1/tpsl/create

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **positionId** (string) - Required - The ID of the position.
- **type** (string) - Required - The type of order ('takeProfit' or 'stopLoss').
- **price** (string) - Required - The price for the TP/SL order.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "positionId": "pos-12345",
  "type": "stopLoss",
  "price": "28000.00"
}
```

### Response
#### Success Response (200)
- **tpslId** (string) - The ID of the created TP/SL order.

#### Response Example
```json
{
  "tpslId": "tpsl-abcde"
}
```
```

```APIDOC
## POST /v1/tpsl/list

### Description
List all take profit / stop loss for given positions.

### Method
POST

### Endpoint
/v1/tpsl/list

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **positionIds** (array of string) - Optional - A list of position IDs to filter by.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "positionIds": ["pos-12345"]
}
```

### Response
#### Success Response (200)
- **tpsls** (array of object) - A list of TP/SL orders.

#### Response Example
```json
{
  "tpsls": [
    {
      "tpslId": "tpsl-abcde",
      "positionId": "pos-12345",
      "type": "stopLoss",
      "price": "28000.00"
    }
  ]
}
```
```

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

### Solvers

Source: https://gw.intentx.io/api/index

Endpoints for retrieving information about solvers and their parameters.

```APIDOC
## GET /v1/solvers/locked-parameters

### Description
Get locked parameters for a specific solver.

### Method
GET

### Endpoint
/v1/solvers/locked-parameters

### Query Parameters
- **solver** (string) - Required - The solver identifier.
- **marketId** (string) - Optional - The market ID to filter by.

### Response
#### Success Response (200)
- **parameters** (object) - The locked parameters for the solver.

#### Response Example
```json
{
  "parameters": {
    "minAmount": "0.01",
    "maxAmount": "1.0"
  }
}
```
```

```APIDOC
## GET /v1/solvers/price-range

### Description
Get price range for a specific solver.

### Method
GET

### Endpoint
/v1/solvers/price-range

### Query Parameters
- **solver** (string) - Required - The solver identifier.
- **marketId** (string) - Required - The market ID.

### Response
#### Success Response (200)
- **priceRange** (object) - The price range for the solver and market.

#### Response Example
```json
{
  "priceRange": {
    "minPrice": "29000.00",
    "maxPrice": "31000.00"
  }
}
```
```

```APIDOC
## GET /v1/solvers/open-interest

### Description
Get open interest for a specific solver.

### Method
GET

### Endpoint
/v1/solvers/open-interest

### Query Parameters
- **solver** (string) - Required - The solver identifier.
- **marketId** (string) - Required - The market ID.

### Response
#### Success Response (200)
- **openInterest** (string) - The open interest value.

#### Response Example
```json
{
  "openInterest": "150.5"
}
```
```

```APIDOC
## GET /v1/solvers/notional-cap

### Description
Get notional cap for a specific solver and market.

### Method
GET

### Endpoint
/v1/solvers/notional-cap

### Query Parameters
- **solver** (string) - Required - The solver identifier.
- **marketId** (string) - Required - The market ID.

### Response
#### Success Response (200)
- **notionalCap** (string) - The notional cap value.

#### Response Example
```json
{
  "notionalCap": "1000000.00"
}
```
```

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

### API Keys Management

Source: https://gw.intentx.io/api/index

Endpoints for managing API keys, including creation, listing, deletion, renaming, and validation.

```APIDOC
## POST /v1/api-keys/create

### Description
Create new API key

### Method
POST

### Endpoint
/v1/api-keys/create

### Request Body
- **name** (string) - Required - The name of the API key.
- **permissions** (array of strings) - Optional - The list of permissions associated with the API key.

### Request Example
```json
{
  "name": "MyNewKey",
  "permissions": ["read", "trade"]
}
```

### Response
#### Success Response (200)
- **apiKey** (string) - The newly created API key.
- **secretKey** (string) - The secret key for the API key.

#### Response Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "secretKey": "YOUR_SECRET_KEY"
}
```
```

```APIDOC
## GET /v1/api-keys/list

### Description
List all API keys

### Method
GET

### Endpoint
/v1/api-keys/list

### Response
#### Success Response (200)
- **apiKeys** (array of ApiKeyDto) - A list of API key objects.

#### Response Example
```json
{
  "apiKeys": [
    {
      "id": "key-id-1",
      "name": "TradingKey",
      "createdAt": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

```APIDOC
## DELETE /v1/api-keys/{id}

### Description
Delete API key

### Method
DELETE

### Endpoint
/v1/api-keys/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the API key to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of deletion.

#### Response Example
```json
{
  "message": "API key deleted successfully."
}
```
```

```APIDOC
## PUT /v1/api-keys/{id}

### Description
Rename API key

### Method
PUT

### Endpoint
/v1/api-keys/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the API key to rename.

### Request Body
- **newName** (string) - Required - The new name for the API key.

### Request Example
```json
{
  "newName": "UpdatedKeyName"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of renaming.

#### Response Example
```json
{
  "message": "API key renamed successfully."
}
```
```

```APIDOC
## POST /v1/api-keys/list-permissions

### Description
Validate API key (This seems to be a duplicate description with the next endpoint, clarifying based on common API patterns).

### Method
POST

### Endpoint
/v1/api-keys/list-permissions

### Request Body
- **apiKey** (string) - Required - The API key to validate.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **permissions** (array of string) - The list of permissions associated with the API key.

#### Response Example
```json
{
  "permissions": ["read", "trade"]
}
```
```

```APIDOC
## POST /v1/api-keys/validate

### Description
Validate API key.

### Method
POST

### Endpoint
/v1/api-keys/validate

### Request Body
- **apiKey** (string) - Required - The API key to validate.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **isValid** (boolean) - True if the API key is valid, false otherwise.

#### Response Example
```json
{
  "isValid": true
}
```
```

```APIDOC
## POST /v1/api-keys/check-permission

### Description
Check if API key has permission for an account. Returns true if the API key has the required permissions, false otherwise.

### Method
POST

### Endpoint
/v1/api-keys/check-permission

### Request Body
- **apiKey** (string) - Required - The API key to check.
- **accountId** (string) - Required - The account ID.
- **permission** (string) - Required - The permission to check.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "accountId": "subaccount-123",
  "permission": "trade"
}
```

### Response
#### Success Response (200)
- **hasPermission** (boolean) - True if the API key has the required permission, false otherwise.

#### Response Example
```json
{
  "hasPermission": true
}
```
```

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

### Account Authentication

Source: https://gw.intentx.io/api/index

Endpoints for managing account authentication and access permissions.

```APIDOC
## POST /v1/account-auth/subaccount/toggle-access

### Description
Toggle API access for a subaccount.

### Method
POST

### Endpoint
/v1/account-auth/subaccount/toggle-access

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **enableAccess** (boolean) - Required - Whether to enable or disable API access.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "enableAccess": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "API access toggled successfully."
}
```
```

```APIDOC
## POST /v1/account-auth/instant-action/token

### Description
Set your account instant action auth token on each solver.

### Method
POST

### Endpoint
/v1/account-auth/instant-action/token

### Request Body
- **solver** (string) - Required - The solver identifier.
- **chainId** (string) - Required - The chain ID.
- **subaccountAddress** (string) - Required - The subaccount address.
- **token** (string) - Required - The instant action auth token.

### Request Example
```json
{
  "solver": "solver-abc",
  "chainId": "eip155:1",
  "subaccountAddress": "0x123...",
  "token": "instant-action-token-xyz"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Instant action token set successfully."
}
```
```

```APIDOC
## DELETE /v1/account-auth/instant-action/token/{chainId}/{solver}/{subaccountAddress}

### Description
Delete instant action auth token.

### Method
DELETE

### Endpoint
/v1/account-auth/instant-action/token/{chainId}/{solver}/{subaccountAddress}

### Parameters
#### Path Parameters
- **chainId** (string) - Required - The chain ID.
- **solver** (string) - Required - The solver identifier.
- **subaccountAddress** (string) - Required - The subaccount address.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Instant action token deleted successfully."
}
```
```

```APIDOC
## GET /v1/account-auth/subaccount/list-api-delegations

### Description
List API access for a subaccount.

### Method
GET

### Endpoint
/v1/account-auth/subaccount/list-api-delegations

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

### Response
#### Success Response (200)
- **delegations** (array of AccountApiKeyPermissionDelegationDto) - A list of API delegations for the subaccount.

#### Response Example
```json
{
  "delegations": [
    {
      "apiKeyIdentifier": "key-id-1",
      "permissions": ["read"],
      "createdAt": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

```APIDOC
## GET /v1/account-auth/verify-instant-action-api-access

### Description
Validate instant action API access.

### Method
GET

### Endpoint
/v1/account-auth/verify-instant-action-api-access

### Query Parameters
- **chainId** (string) - Required - The chain ID.
- **solver** (string) - Required - The solver identifier.
- **subaccountAddress** (string) - Required - The subaccount address.
- **apiKey** (string) - Required - The API key.

### Response
#### Success Response (200)
- **accessValid** (boolean) - True if instant action API access is valid, false otherwise.

#### Response Example
```json
{
  "accessValid": true
}
```
```

```APIDOC
## GET /v1/account-auth/verify

### Description
Validate subaccount API access.

### Method
GET

### Endpoint
/v1/account-auth/verify

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **apiKey** (string) - Required - The API key.

### Response
#### Success Response (200)
- **accessValid** (boolean) - True if subaccount API access is valid, false otherwise.

#### Response Example
```json
{
  "accessValid": true
}
```
```

```APIDOC
## POST /v1/account-auth/delegate-access

### Description
Delegate access from subaccount to API key.

### Method
POST

### Endpoint
/v1/account-auth/delegate-access

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **apiKeyIdentifier** (string) - Required - The identifier of the API key.
- **permissions** (array of string) - Required - The permissions to delegate.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "apiKeyIdentifier": "key-id-1",
  "permissions": ["read"]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Access delegated successfully."
}
```
```

```APIDOC
## DELETE /v1/account-auth/delegation/{subaccountAddress}/{apiKeyIdentifier}

### Description
Remove delegation from subaccount to API key.

### Method
DELETE

### Endpoint
/v1/account-auth/delegation/{subaccountAddress}/{apiKeyIdentifier}

### Parameters
#### Path Parameters
- **subaccountAddress** (string) - Required - The address of the subaccount.
- **apiKeyIdentifier** (string) - Required - The identifier of the API key.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Delegation removed successfully."
}
```
```

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

### Trade

Source: https://gw.intentx.io/api/index

Endpoints for executing trades, including creating, closing, and canceling positions.

```APIDOC
## POST /v1/trade/create-position

### Description
Create a new position.

### Method
POST

### Endpoint
/v1/trade/create-position

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **marketId** (string) - Required - The market ID.
- **side** (string) - Required - The side of the trade (e.g., 'buy', 'sell').
- **amount** (string) - Required - The amount to trade.
- **limitPrice** (string) - Optional - The limit price for the order.
- **stopLoss** (string) - Optional - The stop-loss price.
- **takeProfit** (string) - Optional - The take-profit price.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "marketId": "BTC-USD",
  "side": "buy",
  "amount": "0.1",
  "limitPrice": "30000.00"
}
```

### Response
#### Success Response (200)
- **positionId** (string) - The ID of the created position.

#### Response Example
```json
{
  "positionId": "pos-12345"
}
```
```

```APIDOC
## POST /v1/trade/close-position

### Description
Close an existing position.

### Method
POST

### Endpoint
/v1/trade/close-position

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **positionId** (string) - Required - The ID of the position to close.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "positionId": "pos-12345"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Close position request submitted successfully."
}
```
```

```APIDOC
## POST /v1/trade/cancel-quote

### Description
Cancel an existing position (This description seems to be for canceling a position, not a quote. Assuming it's for canceling a position based on the endpoint).

### Method
POST

### Endpoint
/v1/trade/cancel-quote

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **positionId** (string) - Required - The ID of the position to cancel.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "positionId": "pos-12345"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Cancel position request submitted successfully."
}
```
```

```APIDOC
## POST /v1/trade/cancel-close-request

### Description
Cancel an existing close request.

### Method
POST

### Endpoint
/v1/trade/cancel-close-request

### Request Body
- **subaccountId** (string) - Required - The ID of the subaccount.
- **closeRequestId** (string) - Required - The ID of the close request to cancel.

### Request Example
```json
{
  "subaccountId": "subaccount-1",
  "closeRequestId": "close-req-67890"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Cancel close request submitted successfully."
}
```
```

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

### Accounts

Source: https://gw.intentx.io/api/index

Endpoints for managing and retrieving information about user accounts and subaccounts.

```APIDOC
## GET /v1/accounts/subaccounts

### Description
List all subaccounts for a given user.

### Method
GET

### Endpoint
/v1/accounts/subaccounts

### Response
#### Success Response (200)
- **subaccounts** (array of SubaccountDetailsDto) - A list of subaccount details.

#### Response Example
```json
{
  "subaccounts": [
    {
      "id": "subaccount-1",
      "name": "TradingBot1",
      "createdAt": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

```APIDOC
## GET /v1/accounts/subaccount/details

### Description
Get details for a subaccount.

### Method
GET

### Endpoint
/v1/accounts/subaccount/details

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

### Response
#### Success Response (200)
- **details** (SubaccountDetailsDto) - The details of the subaccount.

#### Response Example
```json
{
  "details": {
    "id": "subaccount-1",
    "name": "TradingBot1",
    "createdAt": "2023-01-01T10:00:00Z"
  }
}
```
```

```APIDOC
## GET /v1/accounts/subaccount/balance

### Description
Get balance details for a subaccount.

### Method
GET

### Endpoint
/v1/accounts/subaccount/balance

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

### Response
#### Success Response (200)
- **balance** (object) - The balance details of the subaccount.

#### Response Example
```json
{
  "balance": {
    "currency": "USDC",
    "available": "1000.00",
    "locked": "50.00"
  }
}
```
```

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

### Positions

Source: https://gw.intentx.io/api/index

Endpoints for retrieving information about opened, closed, and canceled positions.

```APIDOC
## GET /v1/positions/all

### Description
Get all opened positions for a subaccount.

### Method
GET

### Endpoint
/v1/positions/all

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

### Response
#### Success Response (200)
- **positions** (array of PositionDto) - A list of opened positions.

#### Response Example
```json
{
  "positions": [
    {
      "positionId": "pos-12345",
      "marketId": "BTC-USD",
      "side": "buy",
      "amount": "0.1",
      "entryPrice": "29500.00"
    }
  ]
}
```
```

```APIDOC
## GET /v1/positions/open-request/status

### Description
Get a specific position by ID state.

### Method
GET

### Endpoint
/v1/positions/open-request/status

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **positionId** (string) - Required - The ID of the position.

### Response
#### Success Response (200)
- **status** (string) - The status of the position (e.g., 'open', 'filled', 'canceled').

#### Response Example
```json
{
  "status": "filled"
}
```
```

```APIDOC
## GET /v1/positions/close-request/status

### Description
Get a specific close request by ID from the sequencer.

### Method
GET

### Endpoint
/v1/positions/close-request/status

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **closeRequestId** (string) - Required - The ID of the close request.

### Response
#### Success Response (200)
- **status** (string) - The status of the close request.

#### Response Example
```json
{
  "status": "completed"
}
```
```

```APIDOC
## GET /v1/positions/cancel-request/status

### Description
Get a specific cancel request by ID from the sequencer.

### Method
GET

### Endpoint
/v1/positions/cancel-request/status

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **cancelRequestId** (string) - Required - The ID of the cancel request.

### Response
#### Success Response (200)
- **status** (string) - The status of the cancel request.

#### Response Example
```json
{
  "status": "processed"
}
```
```

```APIDOC
## GET /v1/positions/cancel-close-request/status

### Description
Get a specific cancel close request by ID from the sequencer.

### Method
GET

### Endpoint
/v1/positions/cancel-close-request/status

### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **cancelCloseRequestId** (string) - Required - The ID of the cancel close request.

### Response
#### Success Response (200)
- **status** (string) - The status of the cancel close request.

#### Response Example
```json
{
  "status": "processed"
}
```
```
Tokens:
Raw