Arguments

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


Base route	`/v1/arguments`
Endpoints	GET `/v1/arguments` `/v1/arguments/:id`
Produces	JSON
Pagination	No
Application permissions required	"API Access: Create, edit, and delete"
OAuth scopes	`PORTFOLIO`

🔒 Access requirements

"API Access: Create, edit, and delete" application permission and PORTFOLIO OAuth scope are required for all operations.

Resource overview

Attribute	Description
`values`	Values supported by the argument. Boolean or String. Example: `[true, false]`
`default_value`	Default argument value. Boolean or String. Example: `false`
`arg_type`	The argument type determined by its output type. String. Example: `"discrete"`

Get all arguments

Retrieves all attribute arguments supported by the Portfolio Query API.

GET /v1/arguments

🔑 Authentication

All requests require a base64-encoded API key pair:
Authorization: Basic {base64(key_id:key_secret)}
See Access & Authentication for setup.

curl -X GET "https://{firm}.addepar.com/api/v1/arguments" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

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

curl -X GET "https://{firm}.addepar.com/api/v1/arguments/cost_basis_type" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

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

📘 Related resources

Attributes | Portfolio Query | Portfolio Views

Resource overview

Get all arguments

Get argument by ID

What’s Next