Skip to main content
GET
/
tools
/
alpaca
/
get_portfolio_history
{
  "provider": "<string>",
  "timeframe": "<string>",
  "base_value": 123,
  "base_value_asof": "2023-11-07T05:31:56Z",
  "points": [],
  "provider_fields": {}
}

​
alpaca_get_portfolio_history

tools = trading.alpaca(
    api_key=os.environ["ALPACA_KEY"],
    api_secret=os.environ["ALPACA_SECRET"],
    model="openai",
    paper=True,
    minimal=True,
    include=["alpaca_get_portfolio_history"],
)
Options
  • include / exclude: filter which tools are exposed (use full names like alpaca_get_portfolio_history).
  • minimal: omit provider and provider_fields when True.
  • paper: use Alpaca paper trading instead of live trading.

Body

application/json

This is a request to obtain information. Your API keys are required.

​
period
string

Duration like '1D', '1W', '1M', '3M', '1A'.

​
timeframe
string

Resolution: '1Min', '5Min', '15Min', '1H', '1D'.

​
intraday_reporting
string

Intraday reporting mode (provider dependent).

​
start
string

Start timestamp (RFC3339).

​
end
string

End timestamp (RFC3339).

​
pnl_reset
string

PnL reset mode (provider dependent).

​
cashflow_types
string

Cashflow filter (provider dependent).

Response

PortfolioHistory (OpenTools trading schema).

​
provider
string | null

Trading provider identifier. Omitted when minimal=True.

​
timeframe
string | null

Timeframe / resolution used for sampling (e.g. '1Min', '1H', '1D').

​
base_value
number | null

Starting equity value used as a baseline for P&L.

​
base_value_asof
string<date-time> | null

Timestamp corresponding to base_value.

​
points
object[]

Equity and P&L points over time.

​
provider_fields
object

Additional provider-specific fields. Omitted when minimal=True.