holdings

Retrieve a position

Changed on

Retrieve a position within an account.

get/accounts/{account_id}/positions/{position_id}

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

account_idstring required
position_idstring required

Response

OK

accountstring required

ID of the account that owns the position.

automatic_rolloverboolean required

Whether automatic rollover is enabled.

automatic_rollover_cutoffstring date nullable

Last date automatic rollover can be changed.

available_for_tradingstring required

Instrument quantity available for trading.

average_pricestring nullable required

Average acquisition price per instrument unit.

can_update_automatic_rolloverboolean required

Whether automatic rollover can currently be changed.

closed_atstring date-time nullable required

Time the position was closed.

created_atstring date-time required

Time the position record was created.

idstring required

ID of the position.

modified_atstring date-time required

Time the position record was last modified.

most_recent_maturity_periodstring nullable required

Most recent maturity period used for rollover.

opened_atstring date-time required

Time the position was opened.

reservedstring required

Instrument quantity reserved by pending orders.

settledstring required

Settled instrument quantity.

status'open' | 'closing' | 'closed' required
totalstring required

Total instrument quantity held.

total_buy_tradesinteger required

Number of buy trades contributing to the position.

unsettledstring required

Instrument quantity awaiting settlement.

ytmstring nullable required

Yield to maturity as a percentage.

Example response

{
  "automatic_rollover_cutoff": "2025-09-25",
  "available_for_trading": "1000.00",
  "average_price": "98.75",
  "closed_at": "2025-07-15T10:30:00Z",
  "created_at": "2025-01-15T10:30:00Z",
  "instrument": {
    "about": "Common stock listed on the Nasdaq Global Select Market.",
    "asset_class": [
      {
        "weight": "0.48640000"
      }
    ],
    "days_to_maturity": 182,
    "decimal_precision": 2,
    "exchange": "XNAS",
    "icon_url": "https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png",
    "initial_auction_date": "2024-12-30",
    "initial_issue_date": "2025-01-02",
    "isin": "US5949181045",
    "issuer": "United States Department of the Treasury",
    "issuer_country": "US",
    "issuer_credit_rating": "AA+",
    "latest_auction_date": "2025-01-27",
    "latest_issue_date": "2025-01-30",
    "maturity_date": "2025-07-03",
    "name": "Apple Inc.",
    "symbol": "US5949181045",
    "ticker": "AAPL",
    "trading_configuration": {
      "buy": {
        "min_cash_amount": "20000.00000000",
        "min_initial_cash_amount": "100000.00000000",
        "min_initial_quantity": "100.00000000",
        "min_quantity": "10.00000000",
        "modes": [
          "cash"
        ]
      },
      "sell": {
        "min_cash_amount": "1000.00000000",
        "min_quantity": "10.00000000",
        "modes": [
          "quantity"
        ]
      }
    },
    "trading_increment": "0.00010000"
  },
  "modified_at": "2025-07-01T14:32:18Z",
  "most_recent_maturity_period": "3m",
  "opened_at": "2025-01-15T10:30:00Z",
  "reserved": "50.00",
  "settled": "1000.00",
  "total": "1250.00",
  "total_buy_trades": 3,
  "unsettled": "250.00",
  "ytm": "4.25"
}

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new closed enum value to the response property for the response status

    • warning

      added the new closing enum value to the response property for the response status

    • warning

      added the new open enum value to the response property for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property anyOf list for the response status

    • info

      added discriminator to response property for the response status

    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status

    • info

      the response required property // became read-only for the status