Skip to main content
POST
/
api
/
v1
/
custom
/
org
/
{organization_uuid}
/
clients
/
cURL
curl --request POST \
  --url https://api.tilt.io/api/v1/custom/org/{organization_uuid}/clients/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "external_id": "<string>",
  "holdings": {
    "tax_lots": [
      {
        "tilt_asset_id": "<string>",
        "quantity": "<string>",
        "cost_basis": "<string>",
        "trade_date": "2023-12-25",
        "wash_sale_date": "2023-12-25",
        "last_sold_for_loss_date": "2023-12-25"
      }
    ],
    "cash_balance": "<string>",
    "non_tradable_assets_value": "<string>"
  },
  "metadata": "<any>",
  "customization_config": {
    "name": "<string>",
    "risk_model_name": "custom",
    "tilts": [
      {
        "tilt_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "index_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "factor": "<string>"
      }
    ],
    "no_hold_tickers": [
      {
        "tilt_asset_id": "<string>",
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "no_trade_tickers": [
      {
        "tilt_asset_id": "<string>",
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "target_ticker_weights": [
      {
        "tilt_asset_id": "<string>",
        "target_weight": "<string>"
      }
    ],
    "min_weight": "<string>",
    "max_weight": "<string>",
    "scaling_factor": "<string>",
    "use_mean_variance": true,
    "factor_exposure_bounds": [
      {
        "factor": "<string>",
        "min_bound": "<string>",
        "max_bound": "<string>",
        "min_active_bound": "<string>",
        "max_active_bound": "<string>"
      }
    ],
    "tax_preferences": {
      "tax_region": "USA",
      "short_term_rate": "<string>",
      "long_term_rate": "<string>",
      "tax_algorithm": "AVG_COST",
      "tracking_error_threshold": "<string>",
      "wash_sale_threshold": 1073741823,
      "long_term_threshold": 1073741823,
      "ordinary_income_tax_rate": "<string>",
      "n_high_loss_lots": 1073741823,
      "tax_gamma": "<string>"
    },
    "asset_allocations": [
      {
        "asset_class_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target_allocation": "<string>",
        "direct_indexing_enabled": false
      }
    ],
    "bid_ask_spread_ref_volume": "<string>",
    "market_impact_parameter": "<string>",
    "bid_ask_spread_parameter": "<string>",
    "tcost_bps": "<string>"
  },
  "portfolio_config_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset_class_settings": [
    {
      "asset_class_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direct_indexing_enabled": true
    }
  ]
}'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "holdings": {
    "tax_lots": [
      {
        "tilt_asset_id": "<string>",
        "quantity": "<string>",
        "cost_basis": "<string>",
        "trade_date": "2023-12-25",
        "wash_sale_date": "2023-12-25",
        "last_sold_for_loss_date": "2023-12-25"
      }
    ],
    "cash_balance": "<string>",
    "non_tradable_assets_value": "<string>"
  },
  "metadata": "<any>",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "customization_config": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "risk_model_name": "custom",
    "tilts": [
      {
        "tilt": {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "published_at": "2023-11-07T05:31:56Z"
        },
        "index": {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "IN_PROGRESS"
        },
        "factor": "<string>"
      }
    ],
    "no_hold_tickers": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "no_trade_tickers": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "target_ticker_weights": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "target_weight": "<string>"
      }
    ],
    "min_weight": "<string>",
    "max_weight": "<string>",
    "scaling_factor": "<string>",
    "use_mean_variance": true,
    "factor_exposure_bounds": [
      {
        "factor": "<string>",
        "min_bound": "<string>",
        "max_bound": "<string>",
        "min_active_bound": "<string>",
        "max_active_bound": "<string>"
      }
    ],
    "tax_preferences": {
      "tax_region": "USA",
      "short_term_rate": "<string>",
      "long_term_rate": "<string>",
      "tax_algorithm": "AVG_COST",
      "tracking_error_threshold": "<string>",
      "wash_sale_threshold": 1073741823,
      "long_term_threshold": 1073741823,
      "ordinary_income_tax_rate": "<string>",
      "n_high_loss_lots": 1073741823,
      "tax_gamma": "<string>"
    },
    "asset_allocations": [
      {
        "asset_class_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "asset_class_name": "<string>",
        "asset_class_description": "<string>",
        "benchmark_index_identifier": "<string>",
        "benchmark_index_name": "<string>",
        "target_allocation": "<string>",
        "direct_indexing_enabled": true
      }
    ],
    "bid_ask_spread_ref_volume": "<string>",
    "market_impact_parameter": "<string>",
    "bid_ask_spread_parameter": "<string>",
    "tcost_bps": "<string>"
  },
  "portfolio_config": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "risk_model_name": "custom",
    "tilts": [
      {
        "tilt": {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "published_at": "2023-11-07T05:31:56Z"
        },
        "index": {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "IN_PROGRESS"
        },
        "factor": "<string>"
      }
    ],
    "no_hold_tickers": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "no_trade_tickers": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "starts_from": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "target_ticker_weights": [
      {
        "ticker": {
          "tilt_asset_id": "<string>",
          "symbol": "<string>",
          "exchange": "<string>",
          "name": "<string>",
          "description": "<string>",
          "image_url": "<string>",
          "ticker_url": "<string>",
          "ticker_type": "<string>",
          "market_cap": 123,
          "sic_description": "<string>"
        },
        "target_weight": "<string>"
      }
    ],
    "min_weight": "<string>",
    "max_weight": "<string>",
    "scaling_factor": "<string>",
    "use_mean_variance": true,
    "factor_exposure_bounds": [
      {
        "factor": "<string>",
        "min_bound": "<string>",
        "max_bound": "<string>",
        "min_active_bound": "<string>",
        "max_active_bound": "<string>"
      }
    ],
    "tax_preferences": {
      "tax_region": "USA",
      "short_term_rate": "<string>",
      "long_term_rate": "<string>",
      "tax_algorithm": "AVG_COST",
      "tracking_error_threshold": "<string>",
      "wash_sale_threshold": 1073741823,
      "long_term_threshold": 1073741823,
      "ordinary_income_tax_rate": "<string>",
      "n_high_loss_lots": 1073741823,
      "tax_gamma": "<string>"
    },
    "asset_allocations": [
      {
        "asset_class_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "asset_class_name": "<string>",
        "asset_class_description": "<string>",
        "benchmark_index_identifier": "<string>",
        "benchmark_index_name": "<string>",
        "target_allocation": "<string>",
        "direct_indexing_enabled": true
      }
    ],
    "bid_ask_spread_ref_volume": "<string>",
    "market_impact_parameter": "<string>",
    "bid_ask_spread_parameter": "<string>",
    "tcost_bps": "<string>"
  },
  "asset_class_settings": [
    {
      "asset_class": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "benchmark_index_name": "<string>",
        "benchmark_index_identifier": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z"
      },
      "direct_indexing_enabled": true
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
organization_uuid
string<uuid>
required

Body

​
external_id
string
required
​
holdings
object

Serializer for updating holdings data.

​
metadata
any

Store arbitrary metadata about this client in a JSON field, but should not include PII information.

​
customization_config
object
​
portfolio_config_uuid
string<uuid> | null
​
asset_class_settings
object[]

Response

201 - application/json
​
uuid
string<uuid>
required
​
external_id
string
required

External identifier for the client

Maximum length: 50
​
holdings
object
required
​
created
string<date-time>
required
​
modified
string<date-time>
required
​
asset_class_settings
object[]
required
​
metadata
any

Store arbitrary metadata about this client in a JSON field, but should not include PII information.

​
customization_config
object
​
portfolio_config
object
⌘I