Pacifica

https://docs.pacifica.fi/api-documentation/
Admin
Pacifica is a decentralized derivatives trading platform offering REST and Websocket APIs for...
Tokens:68,394
Snippets:472
Trust Score:5.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### HTTP Request and Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-spot-deposit-history

The endpoint uses a GET request to retrieve deposit history. The example shows the base request path and a query with the required account parameter.

```http
GET /api/v1/account/spot_asset/deposit/history
```

```http
/api/v1/account/spot_asset/deposit/history?account=42trU9A5...
```

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

### HTTP Request with Query Parameters

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-balance-history

Example of a GET request with the required account parameter.

```http
/api/v1/account/balance/history?account=42trU9A5...
```

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

### Get Orderbook Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-orderbook

A sample request URL for retrieving the orderbook for the BTC symbol.

```text
api/v1/book?symbol=BTC
```

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

### Python Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-pending-spot-withdrawals

Use the requests library to perform a GET request with the required account parameter.

```python
import requests

response = requests.get(
    "/api/v1/account/spot_asset/withdraw/pending",
    params={"account": "42trU9A5..."},
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### HTTP Request Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-equity-history

Basic HTTP GET request structure for retrieving portfolio history.

```http
GET /api/v1/portfolio
```

```http
/api/v1/portfolio?account=42trU9A5...&time_range=7d
```

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

### HTTP Request and Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-funding-history

Examples showing the endpoint path, a sample request URL with query parameters, and the expected JSON response structure.

```http
GET /api/v1/funding/history
```

```http
/api/v1/funding/history?account=42trU9A5...&limit=20&cursor=11115hVka
```

```json
  {
  "success": true,
  "data": [
    {
      "history_id": 2287920,
      "symbol": "PUMP",
      "side": "ask",
      "amount": "39033804",
      "payout": "2.617479",
      "rate": "0.0000125",
      "created_at": 1759222804122
    },
    ...
  ],
  "next_cursor": "11114Lz77",
  "has_more": true
}
```

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

### Get Account Settings Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-settings

Use the requests library to fetch account settings by providing the account address in the query string.

```python
import requests

response = requests.get(
    "/api/v1/account/settings?account=42trU9A5...",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Prices Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-prices

Implementation using the requests library to retrieve market price data.

```python
import requests

response = requests.get(
    "/api/v1/info/prices",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-loan-info

Example implementation using the requests library to query the loan information endpoint.

```python
import requests

response = requests.get(
    "/api/v1/account/loan",
    params={"account": "42trU9A5..."},
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-spot-withdrawal-history

Example using the requests library to fetch withdrawal history.

```python
import requests

response = requests.get(
    "/api/v1/account/spot_asset/withdraw/history",
    params={"account": "42trU9A5..."},
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Bridge Info Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/spot/get-bridge-info

Implementation using the requests library to fetch bridge information.

```python
import requests

response = requests.get(
    "/api/v1/spot_assets/bridge/info",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/get-open-orders

Example using the requests library to fetch open orders.

```python
import requests

response = requests.get(
    "/api/v1/orders?account=42trU9A5...",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Orderbook Python Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-orderbook

A Python example using the requests library to fetch orderbook data.

```python
import requests

response = requests.get(
    "api.pacifica.fi/api/v1/book?symbol=BTC",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Fee Levels Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-fee-levels

A Python implementation using the requests library to fetch fee levels.

```python
import requests

response = requests.get(
    "/api/v1/info/fees",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Example Request URL

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-candle-data

A sample request URL demonstrating the required query parameters.

```http
/api/v1/kline?symbol=BTC&interval=1m&start_time=1742243160000&end_time=1742243220000
```

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

### Get Prices JSON Response

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-prices

Example of a successful 200 OK response containing market data for a symbol.

```json
 {
  "success": true,
  "data": [
    {
      "funding": "0.00010529",
      "mark": "1.084819",
      "mid": "1.08615",
      "next_funding": "0.00011096",
      "open_interest": "3634796",
      "oracle": "1.084524",
      "symbol": "XPL",
      "timestamp": 1759222967974,
      "volume_24h": "20896698.0672",
      "yesterday_price": "1.3412"
    }
  ],
  "error": null,
  "code": null
}
```

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

### Python Loan Pool Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-loan-pool

Example implementation using the requests library to retrieve loan pool data.

```python
import requests

response = requests.get(
    "/api/v1/loan_pool",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-positions

Example using the requests library to fetch positions.

```python
import requests

response = requests.get(
    "/api/v1/positions?account=42trU9A5...",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-spot-deposit-history

Example using the requests library to fetch deposit history.

```python
import requests

response = requests.get(
    "/api/v1/account/spot_asset/deposit/history",
    params={"account": "42trU9A5..."},
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Mark Price Candle Data Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-mark-price-candle-data

An example request URL with query parameters for symbol, interval, and time range.

```http
/api/v1/kline/mark?symbol=BTC&interval=1m&start_time=1742243160000&end_time=1742243220000
```

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

### Toggle Auto-Lending Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/toggle-auto-lending

Example implementation using the requests library to disable auto-lending.

```python
import requests

# Disable auto-lending
payload = {
    "account": "42trU9A5...",
    "signature": "5J3mBbAH...",
    "timestamp": 1716200000000,
    "disabled": True,
}

response = requests.post(
    "/api/v1/account/settings/auto_lend_disabled",
    json=payload,
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Bridge Parameters Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/spot/get-bridge-parameters

Use the requests library to fetch bridge parameters for a specific asset symbol.

```python
import requests

symbol = "SOL"

response = requests.get(
    f"/api/v1/spot_assets/bridge/parameters/{symbol}",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Create Subaccount Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/subaccounts/create-subaccount

JSON responses for successful creation and error scenarios.

```json
{
  "success": true,
  "data": null,
  "error": null,
  "code": null,
}
```

```json
{
  "success": false,
  "data": null,
  "error": "Account already exists: CRTxBM...",
  "code": 2
}
```

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

### Cancel Stop Order Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/cancel-stop-order

Examples of successful and error responses returned by the API.

```json
  {
    "success": true
  }
```

```json
  {
    "error": "Stop order not found",
    "code": 400
  }
```

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

### API Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-limit-order

JSON responses for successful order creation and error scenarios.

```json
  {
    "order_id": 12345
  }
```

```json
  {
    "error": "Invalid order parameters",
    "code": 400
  }
```

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

### Deposit Request Body Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/vaults/deposit-to-vault

Example JSON payload for the deposit request, including required fields like account, signature, and amount.

```json
{
  "account": "42trU9A5...",
  "signature": "5J3mBbAH...",
  "timestamp": 1716200000000,
  "lake": "AbCdEfGh123456789...",
  "amount": "1000.00",
  "idempotency_key": "550e8400-e29b-41d4-a716-446655440000"
}
```

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

### Python Transfer Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/subaccounts/subaccount-spot-transfer

Example using the requests library to perform a spot asset transfer.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "to_account": "69trU9A5...",
    "symbol": "SOL",
    "amount": "1.50000000",
    "idempotency_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "agent_wallet": "69trU9A5...",
    "expiry_window": 30000,
}

response = requests.post(
    "/api/v1/account/subaccount/spot_asset/transfer",
    headers={"Accept": "*/*", "Content-Type": "application/json"},
    json=payload,
)

data = response.json()
```

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

### Batch Order Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/batch-order

JSON responses for successful batch operations and error scenarios.

```json
{
  "success": true,
  "data": {
    "results": [
      {
        "success": true,
        "order_id": 470506,
        "error": null
      },
      {
        "success": true,
        "order_id": null,
        "error": null
      }
    ]
  },
    "error": null,
    "code": null
}
```

```json
  {
    "error": "Invalid batch operation parameters",
    "code": 400
  }
```

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

### Price Stream Data Format

Source: https://docs.pacifica.fi/api-documentation/api/websocket/subscriptions/prices

Example of the data structure received from the prices channel.

```json
{
    "channel": "prices",
    "data": [
        {
            "funding": "0.0000125",
            "mark": "105473",
            "mid": "105476",
            "next_funding": "0.0000125",
            "open_interest": "0.00524",
            "oracle": "105473",
            "symbol": "BTC",
            "timestamp": 1749051612681,
            "volume_24h": "63265.87522",
            "yesterday_price": "955476"
        }
        // ... other symbol prices
    ],
}
```

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

### Update Margin Mode Responses

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/update-margin-mode

Example JSON responses for successful and failed requests.

```json
 {
    "success": true
  }
```

```json
  {
    "error": "Invalid margin mode",
    "code": 400
  }
```

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

### Edit Order Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/edit-order

Python implementation using the requests library to edit an order.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "price": "90000",
    "amount": "0.5",
    "order_id": 123456789
}

response = requests.post(
    "/api/v1/orders/edit",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### Update Spot Settings Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/update-spot-settings

A Python implementation using the requests library to send a signed update request.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5J3mBbAH...",
    "timestamp": 1716200000000,
    "symbol": "SOL",
    "unified_margin_excluded": True,
}

response = requests.post(
    "/api/v1/account/settings/spot",
    json=payload,
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Create Stop Order API Responses

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-stop-order

Example JSON responses for successful and failed requests.

```json
  {
    "order_id": 12345
  }
```

```json
  {
    "error": "Invalid stop order parameters",
    "code": 400
  }
```

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

### Create Market Order in Python

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-market-order

Example demonstrating how to send a POST request to the market order endpoint using the requests library.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "amount": "0.1",
    "side": "bid",
    "slippage_percent": 1,
    "reduce_only": False,
    "client_order_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

response = requests.post(
    "/api/v1/orders/create_market",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### Fetch Market Info with Python

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-market-info

Example implementation using the requests library to query the market info endpoint.

```python
import requests

response = requests.get(
    "/api/v1/info",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Request for Spot Assets

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/spot/get-spot-assets

Example implementation using the requests library to fetch spot assets.

```python
import requests

response = requests.get(
    "/api/v1/spot_assets",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Request Body Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-position-tp-sl

A JSON object containing the account details, signature, and configuration for both take profit and stop loss orders.

```json
{
  "account": "42trU9A5...",
  "signature": "5j1Vy9Uq...",
  "timestamp": 1716200000000,
  "symbol": "BTC",
  "side": "bid",
  "take_profit": {
    "stop_price": "55000",
    "limit_price": "54950",
    "client_order_id": "e36ac10b-58cc-4372-a567-0e02b2c3d479",
    "trigger_price_type": "mark_price"
  },
  "stop_loss": {
    "stop_price": "48000",
    "limit_price": "47950",
    "client_order_id": "d25ac10b-58cc-4372-a567-0e02b2c3d479",
    "trigger_price_type": "mark_price"
  },
  "agent_wallet": "69trU9A5...",
  "expiry_window": 30000,
  "builder_code": "MYCODE"
}
```

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

### Get Order History by ID Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/get-order-history-by-id

The HTTP GET request structure for retrieving order history.

```http
GET /api/v1/orders/history_by_id
```

```http
/api/v1/orders/history_by_id?order_id=13753364
```

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

### Fetch Mark Price Candle Data in Python

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-mark-price-candle-data

A Python example using the requests library to fetch mark price candle data.

```python
import requests

response = requests.get(
    "/api/v1/kline/mark?symbol=BTC&interval=1m&start_time=1742243160000&end_time=1742243220000",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Get Bridge Info HTTP Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/spot/get-bridge-info

The endpoint requires a GET request to retrieve bridge parameters.

```http
GET /api/v1/spot_assets/bridge/info
```

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

### Get Trade History Endpoint

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-trade-history

The base HTTP GET request structure for retrieving trade history.

```http
GET /api/v1/trades/history
```

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

### Get Fee Levels HTTP Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-fee-levels

The HTTP GET request to retrieve the fee level configuration.

```http
GET /api/v1/info/fees
```

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

### Get Bridge Parameters HTTP Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/spot/get-bridge-parameters

The endpoint requires a GET request with the asset symbol as a path parameter.

```http
GET /api/v1/spot_assets/bridge/parameters/{symbol}
```

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

### Add Isolated Margin Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/add-isolated-margin

Example usage of the add isolated margin endpoint using the requests library.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5J3mBbAH...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "amount": "100.000000",
}

response = requests.post(
    "/api/v1/positions/add_isolated_margin",
    json=payload,
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Python Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-candle-data

A Python implementation using the requests library to fetch candle data.

```python
import requests

response = requests.get(
    "/api/v1/kline?symbol=BTC&interval=1m&start_time=1742243160000&end_time=1742243220000",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Example Final Request Structure

Source: https://docs.pacifica.fi/api-documentation/api/signing/implementation

A sample JSON representation of a fully constructed request including authentication headers and order parameters.

```python
 {
     "account": "6ETnufiec2CxVWTS4u5Wiq33Zh5Y3Qm6Pkdpi375fuxP",
     "agent_wallet": null,
     "signature": "5j1Vy9UqYUF2jKD9r2Lv5AoMWHJuW5a1mqVzEhC9SJL5GqbPkGEQKpW3UZmKXr4UWrHMJ",
     "timestamp": 1748970123456,
     "expiry_window": 5000,
     "symbol": "BTC",
     "price": "100000",
     "amount": "0.1",
     "side": "bid",
     "tif": "GTC",
     "reduce_only": false,
     "client_order_id": "12345678-1234-1234-1234-123456789abc"
 }
```

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

### Correcting GET request structure for CloudFront

Source: https://docs.pacifica.fi/api-documentation/api/api-faq/403-cloudfront

Demonstrates the transition from an invalid GET request containing an empty body to a valid request without a payload.

```shellscript
curl -X GET -H "PF-API-KEY: your-api-key" -H "Content-Type: application/json" -d '{}' "https://api.pacifica.fi/api/v1/positions?account=..."
```

```shellscript
curl -X GET -H "PF-API-KEY: your-api-key" "https://api.pacifica.fi/api/v1/positions?account=..."
```

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

### Create Stop Order Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-stop-order

Implementation using the requests library to send a stop order creation request.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "side": "bid",
    "reduce_only": True,
    "stop_order": {
        "stop_price": "48000",
        "limit_price": "47950",
        "amount": "0.1"
    }
}

response = requests.post(
    "/api/v1/orders/stop/create",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### Python API Request Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-balance-history

Implementation using the requests library to fetch balance history.

```python
import requests

response = requests.get(
    "/api/v1/portfolio?account/balance/history?account=42trU9A5..."
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### GET /api/v1/funding_rate/history

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-historical-funding

Retrieves the historical funding for a particular symbol.

```APIDOC
## GET /api/v1/funding_rate/history

### Description
This endpoint retrieves the historical funding for a particular symbol.

### Method
GET

### Endpoint
/api/v1/funding_rate/history

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Market symbol to query
- **limit** (integer) - Optional - Number of records to show (default 200, max 4000)
- **cursor** (string) - Optional - Cursor pagination to access records

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (array) - List of funding history records
- **next_cursor** (string) - Next cursor for pagination
- **has_more** (boolean) - True if there exists a next_cursor

#### Response Example
{
  "success": true,
  "data": [
    {
      "oracle_price": "117170.410304",
      "bid_impact_price": "117126",
      "ask_impact_price": "117142",
      "funding_rate": "0.0000125",
      "next_funding_rate": "0.0000125",
      "created_at": 1753806934249
    }
  ],
  "next_cursor": "11114Lz77",
  "has_more": true
}
```

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

### GET /api/v1/positions

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-positions

Retrieves the current positions for a specified account.

```APIDOC
## GET /api/v1/positions

### Description
This endpoint allows users to get current positions for a specific account.

### Method
GET

### Endpoint
/api/v1/positions

### Parameters
#### Query Parameters
- **account** (string) - Required - Connected wallet address

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (array) - List of position objects
- **error** (string/null) - Error message if applicable
- **code** (string/null) - Error code if applicable
- **last_order_id** (integer) - Exchange-wide nonce for event ordering

#### Response Example
{
  "success": true,
  "data": [
    {
      "symbol": "AAVE",
      "side": "ask",
      "amount": "223.72",
      "entry_price": "279.283134",
      "margin": "0",
      "funding": "13.159593",
      "isolated": false,
      "liquidation_price": null,
      "created_at": 1754928414996,
      "updated_at": 1759223365538
    }
  ],
  "error": null,
  "code": null,
  "last_order_id": 1557431179
}
```

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

### Update Leverage Response Examples

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/update-leverage

JSON responses for successful and failed leverage update attempts.

```json
 {
    "success": true
  }
```

```json
  {
    "error": "Invalid leverage",
    "code": 400
  }
```

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

### Initialize Keypair

Source: https://docs.pacifica.fi/api-documentation/api/signing/implementation

Generates a keypair from a base58-encoded private key string.

```python
import time
import base58
import requests
from solders.keypair import Keypair

PRIVATE_KEY = "your_private_key_here"

# Generate keypair from private key
keypair = Keypair.from_bytes(base58.b58decode(PRIVATE_KEY))
public_key = str(keypair.pubkey())
```

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

### GET /api/v1/orders/history_by_id

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/get-order-history-by-id

Retrieves the order history for a specific order ID.

```APIDOC
## GET /api/v1/orders/history_by_id

### Description
This endpoint allows users to get order history by id.

### Method
GET

### Endpoint
/api/v1/orders/history_by_id

### Parameters
#### Query Parameters
- **order_id** (integer) - Required - Order ID to retrieve history for
```

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

### Create Limit Order in Python

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-limit-order

Example implementation using the requests library to send a limit order payload.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "price": "50000",
    "amount": "0.1",
    "side": "bid",
    "tif": "GTC",
    "reduce_only": False,
    "client_order_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

response = requests.post(
    "/api/v1/orders/create",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### GET /api/v1/trades

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-recent-trades

Retrieves a list of recent trades for a specified symbol.

```APIDOC
## GET /api/v1/trades

### Description
Retrieves recent trade data for a given symbol. The response includes a top-level `last_order_id` field, which is an exchange-wide nonce used to determine event ordering.

### Method
GET

### Endpoint
/api/v1/trades

### Query Parameters
- **symbol** (string) - Required - The trading symbol to retrieve trades for (e.g., BTC).

### Response
#### Success Response (200)
- **last_order_id** (integer) - Exchange-wide nonce used to reliably determine exchange event ordering.

#### Error Handling
- **400**: Invalid request parameters
- **401**: Unauthorized access
- **500**: Internal server error
```

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

### GET /api/v1/orders/history

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/get-order-history

Retrieves a summarized history of orders for a specific account.

```APIDOC
## GET /api/v1/orders/history

### Description
This endpoint allows users to get a summarized order history.

### Method
GET

### Endpoint
/api/v1/orders/history

### Parameters
#### Query Parameters
- **account** (string) - Required - Account address to filter orders
- **limit** (integer) - Optional - Maximum number of records to return, default to 100
- **cursor** (string) - Optional - Cursor pagination to access records

### Response
#### Success Response (200)
- **success** (boolean) - Status of the request
- **data** (array) - List of order objects
- **next_cursor** (string) - Next cursor for pagination
- **has_more** (boolean) - True if there exists a next_cursor

#### Response Example
{
  "success": true,
  "data": [
    {
      "order_id": 315992721,
      "client_order_id": "ade",
      "symbol": "XPL",
      "side": "ask",
      "initial_price": "1.0865",
      "average_filled_price": "0",
      "amount": "984",
      "filled_amount": "0",
      "order_status": "open",
      "order_type": "limit",
      "stop_price": null,
      "stop_parent_order_id": null,
      "reduce_only": false,
      "reason": null,
      "created_at": 1759224893638,
      "updated_at": 1759224893638
    }
  ],
  "next_cursor": "1111Hyd74",
  "has_more": true
}
```

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

### POST /api/v1/account/api_keys/create

Source: https://docs.pacifica.fi/api-documentation/api/rate-limits/api-config-keys

Creates a new API Config Key for the specified account.

```APIDOC
## POST /api/v1/account/api_keys/create

### Description
Creates a new API Config Key for the user's account.

### Method
POST

### Endpoint
/api/v1/account/api_keys/create

### Parameters
#### Request Body
- **account** (string) - Required - User's wallet address
- **signature** (string) - Required - Cryptographic signature
- **timestamp** (integer) - Required - Current timestamp in milliseconds
- **expiry_window** (integer) - Optional - Signature expiry in milliseconds

### Response
#### Success Response (200)
- **data** (object) - Contains the generated api_key
```

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

### GET /api/v1/orders

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/get-open-orders

Retrieves a list of open orders for the specified account.

```APIDOC
## GET /api/v1/orders

### Description
This endpoint allows users to get open orders on their account.

### Method
GET

### Endpoint
/api/v1/orders

### Parameters
#### Query Parameters
- **account** (string) - Required - Account address to filter orders

### Response
#### Success Response (200)
- **success** (boolean) - Status of the request
- **data** (array) - List of open orders
- **order_id** (integer) - Order id assigned to order
- **client_order_id** (UUID) - CLOID of order if assigned by user
- **symbol** (string) - Trading pair symbol
- **side** (string) - Whether the order is a bid or an ask
- **price** (decimal string) - Price set by the order
- **initial_amount** (decimal string) - Amount (in token denomination) of the order placed
- **filled_amount** (decimal string) - Amount (in token denomination) of the order placed that has been filled
- **cancelled_amount** (decimal string) - Amount (in token denomination) of the order placed that has been cancelled
- **stop_price** (decimal string) - Stop price assigned upon order creation
- **order_type** (string) - Type of order (limit, market, etc.)
- **stop_parent_order_id** (integer) - Order id of stop order attached to original order
- **reduce_only** (boolean) - If the order is reduce only
- **created_at** (integer) - Timestamp in milliseconds when the order was created
- **updated_at** (integer) - Timestamp in milliseconds when the order was last modified
- **last_order_id** (integer) - Exchange-wide nonce

#### Response Example
{
  "success": true,
  "data": [
    {
      "order_id": 315979358,
      "client_order_id": "add9a4b5-c7f7-4124-b57f-86982d86d479",
      "symbol": "ASTER",
      "side": "ask",
      "price": "1.836",
      "initial_amount": "85.33",
      "filled_amount": "0",
      "cancelled_amount": "0",
      "stop_price": null,
      "order_type": "limit",
      "stop_parent_order_id": null,
      "reduce_only": false,
      "created_at": 1759224706737,
      "updated_at": 1759224706737
    }
  ],
  "error": null,
  "code": null,
  "last_order_id": 1557370337
}
```

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

### GET /api/v1/trades/history

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-trade-history

Retrieves trade history for a specified account and symbol.

```APIDOC
## GET /api/v1/trades/history

### Description
Retrieves a list of historical trades for a specific account and symbol. Supports pagination via a cursor.

### Method
GET

### Endpoint
/api/v1/trades/history

### Parameters
#### Query Parameters
- **account** (string) - Required - The account identifier.
- **symbol** (string) - Required - The trading symbol (e.g., BTC).
- **limit** (integer) - Optional - The maximum number of records to return.
- **cursor** (string) - Optional - The pagination cursor for fetching subsequent pages.

### Request Example
GET /api/v1/trades/history?account=42trU9A5...&symbol=BTC&limit=20&cursor=11115hVka
```

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

### GET /api/v1/account/spot_asset/withdraw/history

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-spot-withdrawal-history

Retrieves the withdrawal history for a specified spot account.

```APIDOC
## GET /api/v1/account/spot_asset/withdraw/history

### Description
This endpoint returns spot asset withdrawal history for the provided account address.

### Method
GET

### Endpoint
/api/v1/account/spot_asset/withdraw/history

### Parameters
#### Query Parameters
- **account** (string) - Required - User's wallet address
- **limit** (integer) - Optional - Maximum number of records to return
- **cursor** (string) - Optional - Cursor for pagination

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (array) - List of withdrawal records
- **next_cursor** (string) - Next cursor for pagination
- **has_more** (boolean) - True if there exists a next_cursor

#### Response Example
{
  "success": true,
  "data": [
    {
      "symbol": "SOL",
      "amount": "1.00000000",
      "batch_nonce": 42,
      "transaction_id": "5xGk...",
      "created_at": 1716200000000
    }
  ],
  "next_cursor": "11114Lz77",
  "has_more": true
}
```

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

### Configure Factory MCP Server

Source: https://docs.pacifica.fi/api-documentation/api/mcp/clients

Register the server using the 'droid' CLI or by editing the project or user-level 'mcp.json' file.

```bash
droid mcp add pacifica "npx -y @pacifica-fi/mcp-server" \
  --env ADDRESS=<your account address> \
  --env AGENT_PRIVATE_KEY=<your agent wallet secret key>
```

```json
{
  "mcpServers": {
    "pacifica": {
      "command": "npx",
      "args": ["-y", "@pacifica-fi/mcp-server"],
      "env": {
        "ADDRESS": "<your account address>",
        "AGENT_PRIVATE_KEY": "<your agent wallet secret key>"
      }
    }
  }
}
```

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

### GET /api/v1/account/spot_asset/deposit/history

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-spot-deposit-history

Retrieves the deposit history for a specified wallet address.

```APIDOC
## GET /api/v1/account/spot_asset/deposit/history

### Description
This endpoint returns spot asset deposit history for a given wallet address.

### Method
GET

### Endpoint
/api/v1/account/spot_asset/deposit/history

### Parameters
#### Query Parameters
- **account** (string) - Required - User's wallet address
- **limit** (integer) - Optional - Maximum number of records to return
- **cursor** (string) - Optional - Cursor for pagination

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (array) - List of deposit records
- **symbol** (string) - Spot asset symbol
- **amount** (decimal string) - Amount deposited
- **transaction_id** (string) - On-chain transaction identifier
- **created_at** (integer) - Timestamp in milliseconds of when the deposit occurred
- **next_cursor** (string) - Next cursor for pagination
- **has_more** (boolean) - True if there exists a next_cursor

#### Response Example
{
  "success": true,
  "data": [
    {
      "symbol": "SOL",
      "amount": "1.50000000",
      "transaction_id": "5xGk...",
      "created_at": 1716200000000
    }
  ],
  "next_cursor": "11114Lz77",
  "has_more": true
}
```

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

### Python Portfolio History Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-equity-history

Example implementation using the requests library to fetch portfolio data.

```python
import requests

response = requests.get(
    "/api/v1/portfolio?account=42trU9A5...&time_range=7d",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Edit Order Response

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/edit-order

Example JSON response for a successful order edit.

```json
  {
    "order_id": 123498765
  }
```

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

### Configure OpenAI Codex MCP Server

Source: https://docs.pacifica.fi/api-documentation/api/mcp/clients

Add the server via the CLI or by editing the '~/.codex/config.toml' configuration file.

```bash
codex mcp add pacifica \
  --env ADDRESS=<your account address> \
  --env AGENT_PRIVATE_KEY=<your agent wallet secret key> \
  -- npx -y @pacifica-fi/mcp-server
```

```toml
[mcp_servers.pacifica]
command = "npx"
args = ["-y", "@pacifica-fi/mcp-server"]

[mcp_servers.pacifica.env]
ADDRESS = "<your account address>"
AGENT_PRIVATE_KEY = "<your agent wallet secret key>"
```

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

### Get Orderbook Endpoint Path

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/markets/get-orderbook

The base path for the orderbook retrieval endpoint.

```http
/api/v1/book
```

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

### Cancel All Orders Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/cancel-all-orders

Implementation using the requests library to send a signed POST request.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "all_symbols": True,
    "exclude_reduce_only": False
}

response = requests.post(
    "/api/v1/orders/cancel_all",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### GET /api/v1/account/settings

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-account-settings

Retrieves the margin and leverage settings for a specific account address.

```APIDOC
## GET /api/v1/account/settings

### Description
This endpoint allows users to get account margin and leverage settings. If settings are at default values, they will return blank.

### Method
GET

### Endpoint
/api/v1/account/settings

### Parameters
#### Query Parameters
- **account** (string) - Required - Account address

### Request Example
/api/v1/account/settings?account=42trU9A5...

### Response
#### Success Response (200)
- **auto_lend_disabled** (boolean or null) - Whether automatic lending is disabled for this account. null means default (enabled)
- **margin_settings** (array) - List of margin settings per symbol
- **spot_settings** (array) - Per-asset spot settings for unified margin

#### Response Example
{
  "success": true,
  "data": {
    "auto_lend_disabled": null,
    "margin_settings": [
        {
          "symbol": "WLFI",
          "isolated": false,
          "leverage": 5,
          "created_at": 1758085929703,
          "updated_at": 1758086074002
        }
      ],
      "spot_settings": [
        {
          "symbol": "SOL",
          "unified_margin_excluded": false
        }
      ],
      "error": null,
      "code": null
  }
}
```

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

### Withdraw Spot Asset Python Example

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/withdraw-spot-asset

A Python implementation using the requests library to perform a spot asset withdrawal.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5J3mBbAH...",
    "timestamp": 1716200000000,
    "symbol": "SOL",
    "amount": "1.00000000",
}

response = requests.post(
    "/api/v1/account/spot_asset/withdraw",
    json=payload,
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Account Transfer Stream Payload

Source: https://docs.pacifica.fi/api-documentation/api/websocket/subscriptions/account-transfers

Example of the data structure received from the account_transfers channel.

```json
{
    "channel": "account_transfers",
    "data": {
        "u": "42trU9A5...",
        "e": "deposit",
        "a": "USDC",
        "am": "1000.000000",
        "t": 1716200000000,
        "tx": "5xGk...",
        "bn": 42,
        "ra": "1000.000000",
        "f": "0.500000"
    }
}
```

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

### Trades Stream Data Format

Source: https://docs.pacifica.fi/api-documentation/api/websocket/subscriptions/trades

Example of the data structure received from the trades channel.

```json
{
  "channel": "trades",
  "data": [
    {
      "h": 80062522,
      "s": "BTC",
      "a": "0.00001",
      "p": "89471",
      "d": "close_short",
      "tc": "normal",
      "t": 1765018379085,
      "li": 1559885104,
      "it": 0
    }
  ]
}
```

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

### Update Leverage Python Implementation

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/update-leverage

Example using the requests library to send a POST request to the leverage update endpoint.

```python
import requests

payload = {
    "account": "42trU9A5...",
    "signature": "5j1Vy9Uq...",
    "timestamp": 1716200000000,
    "symbol": "BTC",
    "leverage": 10
}

response = requests.post(
    "/api/v1/account/leverage",
    json=payload,
    headers={"Content-Type": "application/json"}
)

data = response.json()
```

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

### Python Funding History Request

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/account/get-funding-history

Example using the requests library to fetch funding history data.

```python
import requests

response = requests.get(
    "/api/v1/funding/history?account=42trU9A5...&limit=20&cursor=11115hVka",
    headers={"Accept": "*/*"},
)

data = response.json()
```

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

### Account Leverage Stream Data

Source: https://docs.pacifica.fi/api-documentation/api/websocket/subscriptions/account-leverage

Example of the data object received from the account_leverage channel.

```json
{
    "channel": "account_leverage",
    "data": {
        "u": "42trU9A5...",
        "s": "BTC",
        "l": 12,
        "t": 1234567890
    }
}
```

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

### POST /api/v1/orders/create

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/orders/create-limit-order

Creates a new limit order with optional take-profit and stop-loss settings.

```APIDOC
## POST /api/v1/orders/create

### Description
Creates a new limit order on the exchange. Note that TIF GTC and TIF IOC orders are subject to a ~200ms delay to protect liquidity providers.

### Method
POST

### Endpoint
/api/v1/orders/create

### Request Body
- **account** (string) - Required - Account identifier
- **signature** (string) - Required - Request signature
- **timestamp** (integer) - Required - Request timestamp
- **symbol** (string) - Required - Trading symbol
- **price** (string) - Required - Order price
- **amount** (string) - Required - Order amount
- **side** (string) - Required - Order side (e.g., bid)
- **tif** (string) - Required - Time in force (e.g., GTC)
- **reduce_only** (boolean) - Optional - Whether the order is reduce-only
- **client_order_id** (string) - Optional - Unique client order identifier
- **take_profit** (object) - Optional - Take profit configuration
- **stop_loss** (object) - Optional - Stop loss configuration
- **agent_wallet** (string) - Optional - Agent wallet address
- **expiry_window** (integer) - Optional - Expiry window in milliseconds
- **builder_code** (string) - Optional - Builder code

### Request Example
{
  "account": "42trU9A5...",
  "signature": "5j1Vy9Uq",
  "timestamp": 1716200000000,
  "symbol": "BTC",
  "price": "50000",
  "amount": "0.1",
  "side": "bid",
  "tif": "GTC",
  "reduce_only": false,
  "client_order_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

### Response
#### Success Response (200)
- **order_id** (integer) - The unique identifier of the created order

#### Response Example
{
  "order_id": 12345
}
```

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

### Add Vault Blacklist Request Body

Source: https://docs.pacifica.fi/api-documentation/api/rest-api/vaults/add-vault-blacklist

Example JSON payload for the add_blacklist request.

```json
{
  "account": "42trU9A5...",
  "signature": "5J3mBbAH...",
  "timestamp": 1716200000000,
  "lake": "AbCdEfGh123456789...",
  "symbols": ["BTC", "ETH"]
}
```
Tokens:
Raw