Imported Benchmark Data (Beta)

Suggest Edits

Maintain your own custom benchmarks by using imported benchmarks. You can add their daily returns in Addepar, the Import Tool, or via this Imported Benchmark Data API.

📘

Beta Feature

The base route /v1/imported_benchmark_data and all corresponding endpoints described herein are in the Addepar Beta Program. All beta features described herein are provided “as is'” and “as available” with no warranty or guarantee of functionality and may be modified or removed at any time by Addepar.

Please send feedback or questions to your Addepar contact.

Base route/v1/imported_benchmark_data
EndpointsGET
/v1/imported_benchmark_data/:id

PATCH
/v1/imported_benchmark_data/:id
ProducesJSON
PaginationNo
Application permissions required"API Access: Create, edit, and delete"

"Benchmark library"
OAuth scopesBENCHMARKS_READ or BENCHMARKS_WRITE

Resource overview

Imported benchmark data is described by the below resource object attribute and will appear in successful GET responses.

AttributeDescriptionExample
daily_returnsA list of date-value JSON objects indicating daily returns for a particular date. Array.See example below

Get daily returns

Returns all the daily returns for an imported benchmark with the given ID.

GET /v1/imported_benchmark_data/:id

Example

GET https://examplefirm.addepar.com/api/v1/imported_benchmark_data/378862

HTTP/1.1 200 Success

{
    "data": {
        "id": "378862",
        "type": "imported_benchmark_data",
        "attributes": {
            "daily_returns": [
                {
                    "date": "2024-01-01",
                    "value": 0.005
                },
                {
                    "date": "2024-01-02",
                    "value": -0.005
                },
                {
                    "date": "2024-01-03",
                    "value": 0.0
                },
                {
                    "date": "2024-01-04",
                    "value": 0.01
                },
                {
                    "date": "2024-01-05",
                    "value": -0.005
                }
            ]
        },
        "links": {
            "self": "/v1/imported_benchmark_data/378862"
        }
    },
    "included": []
}

Response codes

  • 200 OK: Success.
  • 403 Forbidden: The currently logged-in user does not have permission to access benchmarks.
  • 404 Not Found: No imported benchmark exists corresponding to the provided ID.

Update daily returns

Add new daily returns to an existing imported benchmark.

New daily returns will be appended to existing returns. For dates that already have returns, new returns overwrite existing ones.

PATCH /v1/imported_benchmark_data/:id

Example

PATCH https://examplefirm.addepar.com/api/v1/imported_benchmark_data/378862

{
    "data": {
        "id": "378862",
        "type": "imported_benchmark_data",
        "attributes": {
            "daily_returns": [
                {
                    "date": "2021-01-01",
                    "value": 0.005
                },
                {
                    "date": "2021-01-02",
                    "value": -0.005
                },
                {
                    "date": "2021-01-03",
                    "value": 0.0
                },
                {
                    "date": "2021-01-04",
                    "value": 0.01
                },
                {
                    "date": "2021-01-05",
                    "value": -0.005
                }
            ]
        },
        "links": {
            "self": "/v1/imported_benchmark_data/378862"
        }
    },
    "included": []
}

HTTP/1.1 200 Success

Response codes

  • 200 OK: Success.
  • 400 Bad Request: Invalid request payload.
  • 403 Forbidden: The currently logged-in user does not have permission to update benchmarks.
  • 404 Not Found: No imported benchmark exists corresponding to the provided ID.
  • 409 Conflict: The id field in the request payload does not match the ID in the URL.

Updated 3 months ago