Strategies

Strategies are the core building blocks of portfolio management in Addigence. A strategy defines a set of target positions and weights that the platform uses to rebalance portfolios. On this page, we'll look at how to retrieve strategy details and their current positions.

The strategy model

The strategy model contains the strategy's configuration and metadata.

Properties

Name
id
Type
string
Description
Unique identifier for the strategy (UUID).
Name
name
Type
string
Description
The display name of the strategy.
Name
description
Type
string
Description
A text description of the strategy.
Name
fee_percent
Type
string
Description
The management fee percentage as a decimal string (e.g., "20.00").
Name
is_liquidate_only
Type
boolean
Description
Whether the strategy is in liquidate-only mode, preventing new positions.
Name
liquidate_only_reason
Type
string | null
Description
The reason the strategy was placed in liquidate-only mode, if applicable. Possible values: "ORDER_FAILED", or null.
Name
inserted_at
Type
timestamp
Description
ISO 8601 timestamp of when the strategy was created.
Name
updated_at
Type
timestamp
Description
ISO 8601 timestamp of when the strategy was last updated.
Name
positions
Type
array
Description
The strategy owner's current allocation positions. Only present when requested via ?include=positions.

Position properties

When ?include=positions is specified, each position in the positions array contains:

Name
id
Type
string
Description
Unique identifier for the position (UUID).
Name
symbol
Type
string
Description
The ticker symbol of the security (e.g., "AAPL").
Name
quantity
Type
string
Description
The number of shares held as a decimal string.
Name
inserted_at
Type
timestamp
Description
ISO 8601 timestamp of when the position was created.
Name
updated_at
Type
timestamp
Description
ISO 8601 timestamp of when the position was last updated.

GET/api/v1/strategies/{strategy_id}

Retrieve a strategy

Retrieves a single strategy by ID. The strategy must belong to the same organization as the API client.

Required scope: strategies:read

Path parameters

Name
strategy_id
Type
string
Description
The ID of the strategy to retrieve (UUID).

Optional query parameters

Name
include
Type
string
Description
Comma-separated list of associations to include. Allowed values: positions.

Request

GET

/api/v1/strategies/{strategy_id}?include=positions

curl https://app.addigence.com/api/v1/strategies/019d6f6a-9be4-7d69-a04c-91912a8b9100?include=positions \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "id": "019d6f6a-9be4-7d69-a04c-91912a8b9100",
    "name": "Growth Strategy",
    "description": "A growth-oriented equity strategy",
    "fee_percent": "20.00",
    "is_liquidate_only": false,
    "liquidate_only_reason": null,
    "inserted_at": "2025-01-15T14:30:00.000000Z",
    "updated_at": "2025-03-10T09:15:00.000000Z",
    "positions": [
      {
        "id": "019d6f6a-a1b2-7d69-a04c-91912a8b9200",
        "symbol": "AAPL",
        "quantity": "150.00",
        "inserted_at": "2025-01-15T14:30:00.000000Z",
        "updated_at": "2025-03-10T09:15:00.000000Z"
      },
      {
        "id": "019d6f6a-a1b2-7d69-a04c-91912a8b9201",
        "symbol": "NVDA",
        "quantity": "75.00",
        "inserted_at": "2025-02-01T10:00:00.000000Z",
        "updated_at": "2025-03-10T09:15:00.000000Z"
      }
    ]
  }
}