Arguments are possible settings that can be applied to each instance of an attribute in Addepar. Use the Arguments API in conjunction with the Attributes API to discover available attribute arguments for making Portfolio Query API requests.

Base Route/v1/arguments
EndpointsGET
/v1/arguments
/v1/arguments/:id
ProducesJSON
PaginationNo
Application Permissions Required"API Access: Create, edit, and delete" is required to retrieve available arguments.
OAuth ScopesPORTFOLIO

Resource Overview

Arguments are described by the below resource object attributes and will appear in successful GET responses.

AttributeDescriptionExample
valuesValues supported by the argument. [Boolean or String.][true, false]
default_valueDefault argument value. Boolean or String.false
arg_typeThe argument type which is determined by its output type. String."discrete"

Get All Arguments

Retrieves all attribute arguments supported by the Portfolio Query API.

GET /v1/arguments

Example:

GET https://examplefirm.addepar.com/api/v1/arguments
HTTP/1.1 200

{
  "data": [{
      "id": "adjusted",
      "type": "arguments",
      "attributes": {
        "values": [
          true,
          false
        ],
        "default_value": false
      },
      "links": {
        "self": "/v1/arguments/adjusted"
      }
    },
    {
      "id": "cost_basis_type",
      "type": "arguments",
      "attributes": {
        "values": [
          "ORIGINAL",
          "ADJUSTED",
          "CALCULATED_ADJUSTED",
          "CALCULATED_ADJUSTED_AMORTIZATION_ONLY",
          "CALCULATED_ADJUSTED_ACCRETION_ONLY"
        ],
        "default_value": "ORIGINAL"
      },
      "links": {
        "self": "/v1/arguments/cost_basis_type"
      }
    },
    {
      "id": "distribution_types",
      "type": "arguments",
      "attributes": {
        "values": [
          "GENERIC",
          "CAP_GAIN",
          "LT_CAP_GAIN",
          "ST_CAP_GAIN",
          "INTEREST_INCOME",
          "ORDINARY_INCOME",
          "DIVIDEND_INCOME",
          "RETURN_OF_CAPITAL"
        ],
        "default_value": "all",
        "arg_type": "multi_discrete"
      },
      "links": {
        "self": "/v1/arguments/distribution_types"
      }
    },
    {
      "id": "currency",
      "type": "arguments",
      "attributes": {
        "values": [
          "NATIVE_CURRENCY",
          "USD",
          "EUR",
          "GBP",
          ...,
          "ZWD",
          "ZWL"
        ],
        "default_value": "USD",
        "arg_type": "discrete"
      },
      "links": {
        "self": "/v1/arguments/currency"
      }
    },
    {
      "id": "time_point",
      "type": "arguments",
      "attributes": {
        "default_value": "CURRENT",
        "arg_type": "time_point"
      },
      "links": {
        "self": "/v1/arguments/time_point"
      }
    },
  ],
  "included": [],
  "links": {
    "next": null
  }
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: Insufficient application permissions or appropriate scope not granted

Get Argument By ID

Retrieves the attribute argument with the given ID.

GET /v1/arguments/:id

Example:

GET https://examplefirm.addepar.com/api/v1/arguments/cost_basis_type
HTTP/1.1 200

{
  "data": {
    "id": "cost_basis_type",
    "type": "arguments",
    "attributes": {
      "values": [
        "ORIGINAL",
        "ADJUSTED",
        "CALCULATED_ADJUSTED",
        "CALCULATED_ADJUSTED_AMORTIZATION_ONLY",
        "CALCULATED_ADJUSTED_ACCRETION_ONLY"
      ],
      "default_value": "ORIGINAL"
    },
    "links": {
      "self": "/v1/arguments/cost_basis_type"
    }
  },
  "included": []
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: Insufficient application permissions or appropriate scope not granted
  • 404 Not Found: Argument does not exist

What’s Next

Time to try it out for yourself: