Historical prices represent the price of a share-based investment on a specific date. They're usually created for assets that were held before you used Addepar.

Resource overview

Historical prices are described by the below attributes.

Get historical prices

Returns an entity's historical prices.

GET /v1/entities/:id/prices

• date: The date to retrieve a price for, in YYYY-MM-DD format. If omitted, all of the entity's historical prices will be returned (optional).

Example

GET https://examplefirm.addepar.com/api/v1/entities/60/prices

HTTP/1.1 200 OK

{
    "data": [
        {
            "id": "60_2012-06-29",
            "type": "historical_prices",
            "attributes": {
                "date": "2012-06-29",
                "source": "GLOBAL",
                "value": 101.0,
                "nodeId": 60
            }
        }
    ],
    "included": [],
    "links": {
        "prev": null,
        "next": null
    }
}

Response codes

• 200 OK: Success
• 403 Forbidden: Lacking necessary permissions
• 404 Not Found: Entity ID is nonexistent or not permissioned, or no price was found for the specified date

Create or update historical prices

Creates or updates historical prices for a given entity. This operation is asynchronous and returns the background job's ID.

POST /v1/entities/:id/prices

Example

POST https://examplefirm.addepar.com/api/v1/entities/60/prices

{
    "data": [
        {
            "type":"historical_prices",
            "attributes":{
                "date": "2012-06-29",
                "nodeId": 60,
                "value": 101.0
            }
        }
    ]
}

HTTP/1.1 200 OK

{
    "async_price_save_id": 10
}

Response codes

• 200 OK: Success
• 400 Bad Request: Invalid payload or creating more prices than the limit
• 403 Forbidden: Lacking the required permissions to write prices
• 404 Not Found: Entity ID is nonexistent or not permissioned

Delete historical prices

Deletes an entity's historical price on a specific date. This operation is asynchronous and returns the background job's ID.

DELETE /v1/entities/:id/prices/:date

• date: The date of the price to be deleted, in YYYY-MM-DD format (required).

Example

DELETE https://examplefirm.addepar.com/api/v1/entities/60/prices/2012-06-29

HTTP/1.1 200 OK

{
    "async_price_delete_id": 10
}

Response codes

• 200 OK: Successfully submitted the job to delete prices
• 400 Bad Request: The date query parameter is missing
• 403 Forbidden: Lacking the required permissions to write prices
• 404 Not Found: Entity ID is nonexistent or not permissioned