Warning

The YCharts API is available to our API customers for their internal use only. Any redistribution or commercial use of data from the API is strictly prohibited without prior written consent from YCharts. For more details on our API’s capabilities and pricing please contact sales@ycharts.com or call (866) 965-7552.

Separate Account Holdings

The Separate Account Holdings Endpoint is used to return a list of holdings objects.

Request Info

Request Method

GET

URL

https://api.ycharts.com/v3/separate_accounts/symbol[s]/holdings

Request Parameters

Parameter

Required

Description

symbol[s]

Y

The symbol for a separate account, or a comma separated list of symbols.

Note

  • There is a maximum of 25 symbols per request.

Response Info

The response will contain one or more separate account objects. The key for each separate account object is the symbol passed in the request.

Separate Account Object Fields

Field

Type

Description

meta

Meta

This object contains information about the query for the separate account object.

results

Results

This object contains one or more holding objects.

Holding Object Fields

Field

Type

Description

weight

decimal

Current Weight

name

string

Name

security_id

string

Security ID

Examples

The following is an example successful request for 1 separate account.

Request URL

https://api.ycharts.com/v3/separate_accounts/S:0P00018XD3/holdings

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/separate_accounts/S:0P00018XD3/holdings"
    },
    "response": {
        "S:0P00018XD3": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "holdings": {
                    "meta": {
                        "status": "ok"
                    },
                    "data": [
                        {
                            "weight": 30.00,
                            "name": "Wilshire Premier Alloc. - Mod",
                            "security_id": "WIOPX"
                        }
                    ]
                }
            }
        }
    }
}

The following is an example successful request for multiple separate accounts.

Request URL

https://api.ycharts.com/v3/separate_accounts/S:0P00018XD3,S:0P000171XH/holdings

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/separate_accounts/S:0P00018XD3,S:0P000171XH/holdings"
    },
    "response": {
        "S:0P00018XD3": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "holdings": {
                    "meta": {
                        "status": "ok"
                    },
                    "data": [
                        {
                            "weight": 6.63,
                            "name": "Apple Inc",
                            "security_id": "AAPL"
                        }
                    ]
                }
            }
        },
        "S:0P000171XH": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "holdings": {
                    "meta": {
                        "status": "ok"
                    },
                    "data": [
                        {
                            "weight": 9.27,
                            "name": "Newmont Corp",
                            "security_id": "NEM"
                        }
                    ]
                }
            }
        }
    }
}

The following is an example incorrect request with a nonexistent separate account symbol.

Request URL

https://api.ycharts.com/v3/separate_accounts/S:INVALID/holdings

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/separate_accounts/S:INVALID/holdings"
    },
    "response": {
        "S:INVALID": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "holdings": {
                    "meta": {
                        "status": "error",
                        "error_code": 404,
                        "error_message": "Security Not Found."
                    }
                }
            }
        }
    }
}