Public API

https://public.com/api/docs
Admin
Public API enables commission-free trading of stocks, ETFs, options, and crypto with real-time...
Tokens:92,511
Snippets:681
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Public Python SDK (publicdotcom-py>=0.1.19)

Source: https://public.com/api/docs/templates/tax-lot-selling

Install the Public Python SDK version 0.1.19 or later, which added tax lot support. Required before using the Python SDK examples in this guide.

```bash
pip install "publicdotcom-py>=0.1.19"
```

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

### Python example for GET /userapigateway/trading/{accountId}/taxlots/unrealized/{symbol}

Source: https://public.com/api/docs/resources/tax-lot-selling/get-unrealized-tax-lots-for-symbol

Python example to retrieve unrealized tax lots. Replace placeholders with actual values.

```python
import requests

url = "https://api.public.com/userapigateway/trading/{accountId}/taxlots/unrealized/{symbol}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.json())
```

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

### JavaScript example for GET /userapigateway/trading/{accountId}/taxlots/unrealized/{symbol}

Source: https://public.com/api/docs/resources/tax-lot-selling/get-unrealized-tax-lots-for-symbol

JavaScript example to retrieve unrealized tax lots. Replace placeholders with actual values.

```javascript
fetch('https://api.public.com/userapigateway/trading/{accountId}/taxlots/unrealized/{symbol}', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data));
```

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

### Install Public Agent Skill via prompt

Source: https://public.com/api/docs/templates/openclaw-agent-skill

Prompt OpenClaw to install the Public Agent Skill from its GitHub repository. This setup is required before you can configure your Public API keys.

```text
Can you install the agent skill located here: https://github.com/PublicDotCom/claw-skill-public-dot-com? It is a GitHub repo containing the agent skill for interacting with my Public brokerage account
```

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

### Set up project and install dependencies

Source: https://public.com/api/docs/templates/backtest-with-market-data

Sets up a project directory, Python virtual environment, installs required packages (publicdotcom-py, python-dotenv, pandas, backtesting, TA-Lib), and creates main.py. Note that TA-Lib requires a C library; on macOS run 'brew install ta-lib' first, on Debian/Ubuntu install from package manager or build from source, and on Windows use a prebuilt wheel.

```bash
# Create project folder and cd into it
mkdir public-market-data
cd public-market-data

# Create python env
python3 -m venv .venv
source .venv/bin/activate

# Install public SDK
pip install publicdotcom-py python-dotenv pandas backtesting TA-Lib

# Create a file we will work in
touch main.py
```

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

### Install publicdotcom-cli with uv

Source: https://public.com/api/docs/templates/publicdotcom-cli

Alternative installation method using uv tool install.

```bash
uv tool install publicdotcom-cli
```

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

### Install OpenClaw via curl

Source: https://public.com/api/docs/templates/openclaw-agent-skill

Installs OpenClaw on macOS or Linux. Run this in your terminal, then follow the interactive prompts: choose QuickStart, select Anthropic as your AI provider, paste your API key, and select the model.

```bash
curl -fsSL https://openclaw.ai/install.sh | bash
```

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

### Example output from get_quotes

Source: https://public.com/api/docs/templates/backtest-with-market-data

Example output from the quote-fetching code. Results will vary since this is live market data.

```text
SPY: last=$741.95, bid=$741.96, ask=$742.04, volume=65,363,758
QQQ: last=$685.94, bid=$685.97, ask=$686.0599, volume=64,749,452
```

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

### Backtest stats output example

Source: https://public.com/api/docs/templates/backtest-with-market-data

Example output from bt.run() for a one-week backtest on five-minute bars. Numbers will differ by symbol, date range, and market conditions; replace this block with your own output.

```text
Start                     2026-07-29 09:30:00-04:00
End                       2026-08-04 14:35:00-04:00
Duration                            6 days 05:05:00
Exposure Time [%]                             94.44
Equity Final [$]                          10,412.33
Equity Peak [$]                           10,533.91
Return [%]                                     4.12
Buy & Hold Return [%]                          4.31
Return (Ann.) [%]                            571.24
Volatility (Ann.) [%]                        118.06
Sharpe Ratio                                   4.84
Sortino Ratio                                 18.02
Calmar Ratio                                  92.31
Max. Drawdown [%]                             -6.19
Avg. Drawdown [%]                             -0.87
Max. Drawdown Duration                0 days 06:20:00
# Trades                                         21
Win Rate [%]                                  38.10
Best Trade [%]                                 1.94
Worst Trade [%]                               -0.71
Avg. Trade [%]                                 0.19
Profit Factor                                  1.43
Expectancy [%]                                 0.20
SQN                                            0.92
```

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

### Example response for bond details

Source: https://public.com/api/docs/resources/market-data/get-bond-details

Example JSON response for a successful request (200). Shows all fields returned by the endpoint.

```JSON
{
  "cusip": "string",
  "issuer": "string",
  "issuerSymbol": "string",
  "symbol": "string",
  "description": "string",
  "descriptionShort": "string",
  "bondType": "string",
  "treasurySubtype": "string",
  "treasuryDuration": "string",
  "bondStatus": "string",
  "issueDate": "2023-11-07",
  "issuePrice": "string",
  "issueSize": "string",
  "maturityDate": "2023-11-07",
  "rating": "string",
  "ratingCategory": "string",
  "coupon": "string",
  "couponFrequency": "string",
  "nextCouponDate": "2023-11-07",
  "parValue": "string",
  "accruedInterest": "string",
  "callable": true,
  "nextCallDate": "2023-11-07",
  "nextCallPrice": "string",
  "currentYield": "string",
  "currentPrice": "string",
  "spOutlook": "string",
  "spOutlookDate": "2023-11-07",
  "spCreditwatch": "string",
  "spCreditwatchDate": "2023-11-07",
  "perpetual": true,
  "countryIssue": "string",
  "countryDomicile": "string",
  "daysUntilMaturity": 1234567890,
  "liquidityRating": "string",
  "seniority": "string",
  "partialPar": true,
  "minimumOrderSize": "string",
  "minimumOrderIncrement": "string"
}
```

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

### Install publicdotcom-cli with pipx

Source: https://public.com/api/docs/templates/publicdotcom-cli

Installs the CLI into an isolated environment and puts the 'public' command on your PATH.

```bash
pipx install publicdotcom-cli
```

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

### Successful account response example

Source: https://public.com/api/docs/quickstart

Example JSON response containing account information. The response includes an array of accounts with details such as accountId, accountType, optionsLevel, brokerageAccountType, and tradePermissions.

```json
{
  "accounts": [
    {
      "accountId": "string",
      "accountType": "BROKERAGE",
      "optionsLevel": "NONE",
      "brokerageAccountType": "CASH",
      "tradePermissions": "BUY_AND_SELL"
    }
  ]
}
```

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

### Verify CLI installation with public --help

Source: https://public.com/api/docs/templates/publicdotcom-cli

Prints help output listing available command groups: auth, accounts, market, portfolio, instruments, and order.

```bash
public --help
```

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

### Example response for get history (200)

Source: https://public.com/api/docs/resources/account-details/get-history

Shows the JSON response structure for a successful request. The response includes a list of transactions with fields like timestamp, id, type, subType, and more, along with pagination metadata (nextToken, start, end, pageSize).

```JSON
{
  "transactions": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "id": "string",
      "type": "TRADE",
      "subType": "DEPOSIT",
      "accountNumber": "string",
      "symbol": "string",
      "securityType": "EQUITY",
      "side": "BUY",
      "description": "string",
      "netAmount": "string",
      "principalAmount": "string",
      "quantity": "string",
      "direction": "INCOMING",
      "fees": "string"
    }
  ],
  "nextToken": "string",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "pageSize": 123
}
```

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

### Get order 200 response example

Source: https://public.com/api/docs/resources/order-placement/get-order

Example 200 response body for the Get order endpoint. Shows the full order object including orderId, bracketId, instrument, type, side, status, quantity, expiration, and trades. Note that fields like limitPrice and stopPrice are present only for certain order types, and legs appear only for multi-leg instruments.

```json
{
  "orderId": "string",
  "bracketId": "string",
  "instrument": {
    "symbol": "string",
    "type": "EQUITY"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "MARKET",
  "side": "BUY",
  "status": "NEW",
  "quantity": "string",
  "notionalValue": "string",
  "expiration": {
    "timeInForce": "DAY",
    "expirationTime": "2023-11-07T05:31:56Z"
  },
  "limitPrice": "string",
  "stopPrice": "string",
  "closedAt": "2023-11-07T05:31:56Z",
  "openCloseIndicator": "OPEN",
  "filledQuantity": "string",
  "averagePrice": "string",
  "legs": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "side": "BUY",
      "openCloseIndicator": "OPEN",
      "ratioQuantity": 123
    }
  ],
  "equityMarketSession": "REGULAR",
  "filledAt": "2023-11-07T05:31:56Z",
  "replacedAt": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "trades": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "quantity": "string",
      "price": "string",
      "side": "BUY",
      "tradeId": "string",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "rejectReason": "string"
}
```

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

### Place order with public order place

Source: https://public.com/api/docs/templates/publicdotcom-cli

Submits a real order against your live brokerage account. Review preflight output carefully before running.

```bash
public order place --file order.json
```

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

### Python request to get instrument

Source: https://public.com/api/docs/resources/instrument-details/get-instrument

Python example for retrieving instrument details. Uses the requests library with the same endpoint and authorization header.

```Python
import requests

url = "https://api.public.com/userapigateway/trading/instruments/{symbol}/{type}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())
```

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

### Response 200 for GET /userapigateway/trading/{accountId}/taxlots/unrealized/{symbol}

Source: https://public.com/api/docs/resources/tax-lot-selling/get-unrealized-tax-lots-for-symbol

Example of a successful 200 response containing the unrealized tax lots data.

```json
{
  "asOf": "2023-11-07",
  "symbol": "string",
  "companyName": "string",
  "lots": [
    {
      "quantity": "string",
      "costBasis": "string",
      "unitCost": "string",
      "currentPrice": "string",
      "currentValue": "string",
      "gainLoss": "string",
      "openDate": "2023-11-07",
      "term": "string",
      "washSale": true,
      "shortTermGainLoss": "string",
      "longTermGainLoss": "string",
      "openBuyPrice": "string",
      "lotSelectionId": "string",
      "outOfDateStatus": {
        "type": "PRE_EXISTING_OPEN_ORDER_ON_SYMBOL",
        "order": {
          "id": "string",
          "description": "string"
        },
        "description": {
          "header": "string",
          "body": "string"
        }
      }
    }
  ],
  "details": null
}
```

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

### Show portfolio with public portfolio show

Source: https://public.com/api/docs/templates/publicdotcom-cli

Verifies your holdings at any time.

```bash
public portfolio show
```

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

### Example response for get instrument

Source: https://public.com/api/docs/resources/instrument-details/get-instrument

Shows the JSON structure returned by the endpoint, including instrument details, trading flags, and price increments.

```JSON
{
  "instrument": {
    "symbol": "string",
    "type": "EQUITY"
  },
  "trading": "BUY_AND_SELL",
  "fractionalTrading": "BUY_AND_SELL",
  "optionTrading": "BUY_AND_SELL",
  "optionSpreadTrading": "BUY_AND_SELL",
  "instrumentDetails": null,
  "shortingAvailability": "NOT_SHORTABLE",
  "hardToBorrowPercentageRate": "string",
  "optionContractPriceIncrements": {
    "incrementBelow3": "string",
    "incrementAbove3": "string"
  },
  "exchange": "string",
  "exchangeName": "string"
}
```

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

### JavaScript request to get instrument

Source: https://public.com/api/docs/resources/instrument-details/get-instrument

JavaScript example using fetch to call the instrument endpoint. Includes the Authorization header and handles the response.

```JavaScript
fetch('https://api.public.com/userapigateway/trading/instruments/{symbol}/{type}', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data));
```

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

### 200 response for get all instruments

Source: https://public.com/api/docs/resources/instrument-details/get-all-instruments

Example JSON response returned when the request succeeds. Contains an array of instruments with details such as symbol, type, trading statuses, and exchange information.

```JSON
{
  "instruments": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "trading": "BUY_AND_SELL",
      "fractionalTrading": "BUY_AND_SELL",
      "optionTrading": "BUY_AND_SELL",
      "optionSpreadTrading": "BUY_AND_SELL",
      "instrumentDetails": null,
      "shortingAvailability": "NOT_SHORTABLE",
      "hardToBorrowPercentageRate": "string",
      "optionContractPriceIncrements": {
        "incrementBelow3": "string",
        "incrementAbove3": "string"
      },
      "exchange": "string",
      "exchangeName": "string"
    }
  ]
}
```

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

### 200 Response for unrealized tax lots CSV

Source: https://public.com/api/docs/resources/tax-lot-selling/get-unrealized-tax-lots-csv

Example 200 response body for the GET unrealized tax lots CSV endpoint. Contains the file name and the CSV data encoded in base64.

```json
{
  "fileName": "string",
  "base64Data": "string"
}
```

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

### Create .env file with API credentials

Source: https://public.com/api/docs/templates/backtest-with-market-data

Creates a .env file next to main.py with the required environment variables for the Public API: PUBLIC_API_SECRET_KEY and PUBLIC_DEFAULT_ACCOUNT_NUMBER.

```bash
PUBLIC_API_SECRET_KEY=your_secret_key_here
PUBLIC_DEFAULT_ACCOUNT_NUMBER=your_account_number_here
```

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

### Python SDK: client.place_order(order)

Source: https://public.com/api/docs/templates/tax-lot-selling

Places a sell order with tax lot matching instructions using the Python SDK.

```APIDOC
## Python SDK: client.place_order(order)

### Description
Places a sell order with tax lot matching instructions using the Python SDK.

### Method
place_order

### Parameters
- **order** (OrderRequest) - Required - The order request object.
  - **order_id** (str) - Required - Unique identifier for the order.
  - **instrument** (OrderInstrument) - Required - The instrument to trade.
    - **symbol** (str) - Required - The ticker symbol.
    - **type** (InstrumentType) - Required - The instrument type (e.g., EQUITY).
  - **order_side** (OrderSide) - Required - The side of the order (SELL).
  - **order_type** (OrderType) - Required - The type of order (LIMIT or MARKET).
  - **limit_price** (Decimal) - Optional - The limit price for LIMIT orders.
  - **expiration** (OrderExpirationRequest) - Required - Expiration details.
    - **time_in_force** (TimeInForce) - Required - Time in force (e.g., DAY).
  - **quantity** (Decimal) - Required - The total quantity to sell.
  - **open_close_indicator** (OpenCloseIndicator) - Required - Must be CLOSE for tax lot instructions.
  - **tax_lot_matching_instructions** (list of GatewayTaxLotMatchingInstruction) - Required - List of tax lot instructions.
    - **tax_lot_id** (str) - Required - The lot selection ID of the lot.
    - **quantity** (str) - Required - Quantity to sell from this lot.

### Request Example
```python
import uuid
from decimal import Decimal

from public_api_sdk import (
    GatewayTaxLotMatchingInstruction,
    InstrumentType,
    OpenCloseIndicator,
    OrderExpirationRequest,
    OrderInstrument,
    OrderRequest,
    OrderSide,
    OrderType,
    TimeInForce,
)

order = OrderRequest(
    order_id=str(uuid.uuid4()),
    instrument=OrderInstrument(symbol="AAPL", type=InstrumentType.EQUITY),
    order_side=OrderSide.SELL,
    order_type=OrderType.LIMIT,
    limit_price=Decimal("212.00"),
    expiration=OrderExpirationRequest(time_in_force=TimeInForce.DAY),
    quantity=Decimal("12"),
    open_close_indicator=OpenCloseIndicator.CLOSE,
    tax_lot_matching_instructions=[
        GatewayTaxLotMatchingInstruction(
            tax_lot_id="AAPL;2024-01-15;150.00;10",
            quantity="10",
        ),
        GatewayTaxLotMatchingInstruction(
            tax_lot_id="AAPL;2026-03-10;180.00;5",
            quantity="2",
        ),
    ],
)

new_order = client.place_order(order)
print(f"Order submitted: {new_order.order_id}")
```

### Response
- **order_id** (str) - The ID of the submitted order.

### Notes
- Only allowed on SELL equity orders that close a position, and only for MARKET or good-for-the-day LIMIT orders.
- At most 8 instructions per order, all for the order's symbol, and their quantities must sum exactly to the order quantity.
- A lot's instruction quantity must be greater than 0 and no more than the lot's quantity.
- Instructions are only accepted while the tax lot information is current.
- There is no guarantee the instructions are applied exactly as specified.
- Order placement is asynchronous – poll the order status after submission to confirm execution.
```

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

### Example response for Get Bars V2 with Aggregation

Source: https://public.com/api/docs/resources/market-data/get-bars-v2-with-aggregation

Shows the JSON structure returned on a successful 200 response, including bar data for pre-market, regular market, after-market, and overnight sessions.

```json
{
  "symbol": "string",
  "period": "string",
  "totalExpectedBars": 123,
  "previousClosePrice": "string",
  "totalGainLoss": "string",
  "totalGainLossPercentage": "string",
  "preMarket": {
    "expectedBars": 123,
    "bars": [
      {
        "timestamp": "string",
        "open": "string",
        "close": "string",
        "high": "string",
        "low": "string",
        "value": "string",
        "volume": 123,
        "gainAmount": "string",
        "gainPercentage": "string"
      }
    ]
  },
  "regularMarket": {
    "expectedBars": 123,
    "bars": [
      {
        "timestamp": "string",
        "open": "string",
        "close": "string",
        "high": "string",
        "low": "string",
        "value": "string",
        "volume": 123,
        "gainAmount": "string",
        "gainPercentage": "string"
      }
    ]
  },
  "afterMarket": {
    "expectedBars": 123,
    "bars": [
      {
        "timestamp": "string",
        "open": "string",
        "close": "string",
        "high": "string",
        "low": "string",
        "value": "string",
        "volume": 123,
        "gainAmount": "string",
        "gainPercentage": "string"
      }
    ]
  },
  "preMarketOvernight": {
    "expectedBars": 123,
    "bars": [
      {
        "timestamp": "string",
        "open": "string",
        "close": "string",
        "high": "string",
        "low": "string",
        "value": "string",
        "volume": 123,
        "gainAmount": "string",
        "gainPercentage": "string"
      }
    ]
  },
  "postMarketOvernight": {
    "expectedBars": 123,
    "bars": [
      {
        "timestamp": "string",
        "open": "string",
        "close": "string",
        "high": "string",
        "low": "string",
        "value": "string",
        "volume": 123,
        "gainAmount": "string",
        "gainPercentage": "string"
      }
    ]
  },
  "lastTradingSessionClose": {
    "close": "string",
    "closeDate": "string",
    "change": "string",
    "percentChange": "string"
  },
  "regularSessionClosingData": {
    "timestamp": "string",
    "price": "string"
  },
  "lastRegularTradingSessionClose": {
    "close": "string",
    "closeDate": "string",
    "change": "string",
    "percentChange": "string"
  },
  "leadingFill": {
    "startTimestamp": "string",
    "endTimestamp": "string",
    "value": "string",
    "count": 123,
    "includedInTotalExpectedBars": true
  }
}
```

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

### Run preflight on the entry with curl

Source: https://public.com/api/docs/templates/place-bracket-order

Preflight estimates cost and buying power for the entry order. Send the entry exactly as planned but without bracket fields (no orderClass, takeProfit, or stopLoss).

```bash
curl --request POST \
  --url https://api.public.com/userapigateway/trading/{YOUR_ACCOUNT_ID}/preflight/single-leg \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "instrument": {
      "symbol": "AAPL",
      "type": "EQUITY"
    },
    "orderSide": "BUY",
    "orderType": "LIMIT",
    "limitPrice": "150.00",
    "expiration": {
      "timeInForce": "DAY"
    },
    "quantity": "10"
  }'
```

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

### 200 Response Body for Get Account Portfolio v2

Source: https://public.com/api/docs/resources/account-details/get-account-portfolio-v2

Example JSON response body for a successful (200) portfolio request. Shows the structure for account details, buying power, equity, positions, orders, strategies, cash, total account value, and available to withdraw.

```json
{
  "accountId": "string",
  "accountType": "BROKERAGE",
  "buyingPower": {
    "cashOnlyBuyingPower": "string",
    "buyingPower": "string",
    "optionsBuyingPower": "string"
  },
  "equity": [
    {
      "type": "CASH",
      "value": "string",
      "percentageOfPortfolio": "string"
    }
  ],
  "positions": [
    {
      "instrument": {
        "symbol": "string",
        "name": "string",
        "type": "EQUITY"
      },
      "quantity": "string",
      "openedAt": "2023-11-07T05:31:56Z",
      "currentValue": "string",
      "percentOfPortfolio": "string",
      "lastPrice": {
        "lastPrice": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "instrumentGain": {
        "gainValue": "string",
        "gainPercentage": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "positionDailyGain": {
        "gainValue": "string",
        "gainPercentage": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "costBasis": {
        "totalCost": "string",
        "unitCost": "string",
        "gainValue": "string",
        "gainPercentage": "string",
        "lastUpdate": "2023-11-07T05:31:56Z"
      },
      "strategyIds": [
        "string"
      ]
    }
  ],
  "orders": [
    {
      "orderId": "d82612db-2464-4ad5-9376-c6206ba351a7",
      "bracketId": "b3fae9a6-4e88-4fee-9384-1f9f540a0f17",
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "MARKET",
      "side": "BUY",
      "status": "NEW",
      "quantity": "string",
      "notionalValue": "string",
      "expiration": {
        "timeInForce": "DAY",
        "expirationTime": "2023-11-07T05:31:56Z"
      },
      "limitPrice": "string",
      "stopPrice": "string",
      "closedAt": "2023-11-07T05:31:56Z",
      "openCloseIndicator": "OPEN",
      "filledQuantity": "string",
      "averagePrice": "string",
      "legs": [
        {
          "instrument": {
            "symbol": "string",
            "type": "EQUITY"
          },
          "side": "BUY",
          "openCloseIndicator": "OPEN",
          "ratioQuantity": 123
        }
      ],
      "rejectReason": "string"
    }
  ],
  "strategies": [
    {
      "strategyId": "string",
      "displayName": "string",
      "quantity": "string",
      "currentValue": "string",
      "percentOfPortfolio": "string",
      "lastPrice": {
        "lastPrice": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "positionDailyGain": {
        "gainValue": "string",
        "gainPercentage": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "costBasis": {
        "totalCost": "string",
        "unitCost": "string",
        "gainValue": "string",
        "gainPercentage": "string",
        "lastUpdate": "2023-11-07T05:31:56Z"
      },
      "optionLegs": [
        {
          "symbol": "string",
          "positionType": "string",
          "ratioQuantity": "string"
        }
      ]
    }
  ],
  "cash": "string",
  "totalAccountValue": "string",
  "availableToWithdraw": {
    "cashOnlyAvailableToWithdraw": "string",
    "availableToWithdraw": "string"
  }
}
```

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

### Make first request to get account information using curl

Source: https://public.com/api/docs/quickstart

Use this curl command to retrieve account information. Replace YOUR_ACCESS_TOKEN with the access token obtained from the authorization step.

```bash
curl --request GET \
  --url https://api.public.com/userapigateway/trading/account \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json'
```

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

### Preflight response with estimated cost

Source: https://public.com/api/docs/templates/place-multi-leg-options-order

Example preflight response showing estimated net cost, strategy details, and regulatory fees.

```json
{
  "baseSymbol": "AAPL",
  "strategyName": "Call Spread",
  "legs": [
    {
      "instrument": {
        "symbol": "AAPL240216C00140000",
        "type": "OPTION"
      },
      "side": "BUY",
      "openCloseIndicator": "OPEN",
      "ratioQuantity": 1,
      "optionDetails": {
        "baseSymbol": "AAPL",
        "type": "CALL",
        "strikePrice": "140.00",
        "optionExpireDate": "2024-02-16"
      }
    },
    {
      "instrument": {
        "symbol": "AAPL240216C00150000",
        "type": "OPTION"
      },
      "side": "SELL",
      "openCloseIndicator": "OPEN",
      "ratioQuantity": 1,
      "optionDetails": {
        "baseSymbol": "AAPL",
        "type": "CALL",
        "strikePrice": "150.00",
        "optionExpireDate": "2024-02-16"
      }
    }
  ],
  "estimatedCommission": "1.30",
  "orderValue": "500.00",
  "estimatedQuantity": "1",
  "estimatedCost": "501.30",
  "buyingPowerRequirement": "501.30",
  "regulatoryFees": {
    "orfFee": "0.08",
    "occFee": "0.04"
  }
}
```

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

### PUT /userapigateway/trading/{accountId}/order

Source: https://public.com/api/docs/resources/order-placement/replace-order

Submits a request to replace an existing order asynchronously for the specified account. A replacement lets you modify an open order (for example, its quantity or price) without cancelling and resubmitting it manually. Note: Order replacement is asynchronous. This response confirms submission only. To verify the order status or execution details, use the GET /{orderId} endpoint after replacement.

```APIDOC
## [PUT] /userapigateway/trading/{accountId}/order

### Description
Submits a request to replace an existing order asynchronously for the specified account. A replacement lets you modify an open order (for example, its quantity or price) without cancelling and resubmitting it manually. Note: Order replacement is asynchronous. This response confirms submission only. To verify the order status or execution details, use the GET /{orderId} endpoint after replacement.

### Method
PUT

### Endpoint
/userapigateway/trading/{accountId}/order

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account identifier.

#### Request Body
- **orderId** (string) - Required - This value identifies the order to be replaced; if reused on the same account, the operation is idempotent. If the order is re-submitted due to a read timeout, do not modify any properties. If the original request succeeded, altering fields will have no effect.
- **requestId** (string) - Required - Id of the new order in UUID-format conforming to RFC 4122 (standard 8-4-4-4-12 format, e.g., 0d2abd8d-3625-4c83-a806-98abf35567cc). The new orderId must be globally unique over time.
- **orderType** (enum<string>) - Required - The Type of order. Available options: `MARKET`, `LIMIT`, `STOP`, `STOP_LIMIT`
- **expiration** (object) - Required - The expiration details.
- **quantity** (string) - Optional - The order quantity. Used when buying/selling whole shares and when selling fractional. Mutually exclusive with `amount`
- **amount** (string) - Optional - The order amount. Used when replacing an order for a specific notional value. Mutually exclusive with `quantity`
- **limitPrice** (string) - Optional - The limit price. Used when orderType = LIMIT or orderType = STOP_LIMIT
- **stopPrice** (string) - Optional - The stop price. Used when orderType = STOP or orderType = STOP_LIMIT

### Request Example
```json
{
  "orderId": "92de2e9f-36d7-43ee-aded-ab0746dc2501",
  "requestId": "b53917e0-eb77-4ea1-b6eb-9ab5ddde5f00",
  "orderType": "LIMIT",
  "expiration": {
    "timeInForce": "GTD",
    "expirationTime": "2027-01-04T14:40:39.267Z"
  },
  "quantity": "string",
  "amount": "string",
  "limitPrice": "string",
  "stopPrice": "string"
}
```

### Response
#### Success Response (200)
- **orderId** (string) - The ID of the replaced order.

#### Response Example
```json
{
  "orderId": "06261de7-de18-4ac0-bf63-4a7627ea3665"
}
```

#### Error Response (400)
Order validation failed.
No response body defined.

```

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

### Run backtest with Backtest and SmaCross

Source: https://public.com/api/docs/templates/backtest-with-market-data

Runs a backtest with the Backtest library using the SmaCross strategy, zero commission, and exclusive orders. bt.run() returns a stats object and bt.plot() opens an interactive chart in the browser showing the equity curve, moving averages, and trades.

```python
bt = Backtest(df, SmaCross, commission=0, exclusive_orders=True)
stats = bt.run()
print(stats)
bt.plot()
```

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

### Preflight response

Source: https://public.com/api/docs/templates/place-bracket-order

Example response providing estimated costs and order details from the preflight request.

```json
{
  "instrument": {
    "symbol": "AAPL",
    "type": "EQUITY"
  },
  "estimatedCommission": "0.00",
  "orderValue": "1500.00",
  "estimatedQuantity": "10",
  "estimatedCost": "1500.00",
  "buyingPowerRequirement": "1500.00",
  "regulatoryFees": {
    "secFee": "0.00",
    "tafFee": "0.00"
  }
}
```
Tokens:
Raw