curl --request GET \
--url https://api.tilt.io/api/v1/custom/org/{organization_uuid}/clients/{uuid}/ \
--header 'X-Api-Key: <api-key>'{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"holdings": {
"tax_lots": [
{
"tilt_asset_id": "<string>",
"ticker_symbol": "<string>",
"ticker_name": "<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>"
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"asset_class_settings": [
{
"asset_class": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"benchmark_index_name": "<string>",
"benchmark_index_identifier": "<string>",
"index_name": "<string>",
"index_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
},
"direct_indexing_enabled": true
}
],
"metadata": "<unknown>",
"customization_config": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"optimization_mode": "LONG_ONLY",
"long_weight_sum": "<string>",
"short_weight_sum": "<string>",
"risk_model_name": "custom",
"tilts": [
{
"factor": "<string>",
"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"
}
}
],
"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>",
"min_active_weight": "<string>",
"max_active_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,
"tilts": [
{
"factor": "<string>",
"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"
},
"impacts_non_benchmark_assets": true,
"is_part_of_benchmark": 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>",
"optimization_mode": "LONG_ONLY",
"long_weight_sum": "<string>",
"short_weight_sum": "<string>",
"risk_model_name": "custom",
"tilts": [
{
"factor": "<string>",
"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"
}
}
],
"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>",
"min_active_weight": "<string>",
"max_active_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,
"tilts": [
{
"factor": "<string>",
"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"
},
"impacts_non_benchmark_assets": true,
"is_part_of_benchmark": true
}
]
}
],
"bid_ask_spread_ref_volume": "<string>",
"market_impact_parameter": "<string>",
"bid_ask_spread_parameter": "<string>",
"tcost_bps": "<string>"
}
}View for retrieving and updating organization clients.
Supports:
curl --request GET \
--url https://api.tilt.io/api/v1/custom/org/{organization_uuid}/clients/{uuid}/ \
--header 'X-Api-Key: <api-key>'{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"holdings": {
"tax_lots": [
{
"tilt_asset_id": "<string>",
"ticker_symbol": "<string>",
"ticker_name": "<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>"
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"asset_class_settings": [
{
"asset_class": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"benchmark_index_name": "<string>",
"benchmark_index_identifier": "<string>",
"index_name": "<string>",
"index_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
},
"direct_indexing_enabled": true
}
],
"metadata": "<unknown>",
"customization_config": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"optimization_mode": "LONG_ONLY",
"long_weight_sum": "<string>",
"short_weight_sum": "<string>",
"risk_model_name": "custom",
"tilts": [
{
"factor": "<string>",
"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"
}
}
],
"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>",
"min_active_weight": "<string>",
"max_active_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,
"tilts": [
{
"factor": "<string>",
"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"
},
"impacts_non_benchmark_assets": true,
"is_part_of_benchmark": 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>",
"optimization_mode": "LONG_ONLY",
"long_weight_sum": "<string>",
"short_weight_sum": "<string>",
"risk_model_name": "custom",
"tilts": [
{
"factor": "<string>",
"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"
}
}
],
"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>",
"min_active_weight": "<string>",
"max_active_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,
"tilts": [
{
"factor": "<string>",
"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"
},
"impacts_non_benchmark_assets": true,
"is_part_of_benchmark": true
}
]
}
],
"bid_ask_spread_ref_volume": "<string>",
"market_impact_parameter": "<string>",
"bid_ask_spread_parameter": "<string>",
"tcost_bps": "<string>"
}
}External identifier for the client
50Show child attributes
Show child attributes
The cash value of the non-tradable assets.
Show child attributes
Serializer for reading AssetClass data.
Show child attributes
255Whether direct indexing is enabled for this asset class for this client
Store arbitrary metadata about this client in a JSON field, but should not include PII information.
Show child attributes
255Optimization mode to use for portfolio optimization, this can be LONG_ONLY, LONG_SHORT, or LONG_BIASED.
LONG_ONLY - Long OnlyLONG_SHORT - Long ShortLONG_BIASED - Long BiasedLONG_ONLY, LONG_SHORT, LONG_BIASED Target sum of long weights for LONG_SHORT or LONG_BIASED optimization modes (e.g., 2.5 for 250% long).
Target sum of short weights for LONG_SHORT or LONG_BIASED optimization modes (e.g., -2.5 for -250% short).
Risk model to use for portfolio optimization
custom - Custompca - Pcacharacteristics - Characteristicscustom, pca, characteristics Show child attributes
Show child attributes
255IN_PROGRESS - In ProgressSUBMITTED - SubmittedAPPROVED - ApprovedREJECTED - RejectedIN_PROGRESS, SUBMITTED, APPROVED, REJECTED Show child attributes
Show child attributes
The date from which the ticker should no longer be held.
The date at which the ticker may be held again.
Show child attributes
Show child attributes
The date from which the ticker should no longer be traded.
The date at which the ticker may be traded again.
Show child attributes
Show child attributes
Show child attributes
128Show child attributes
Tax region for tax calculation
USA - UsaCANADA - CanadaUSA, CANADA Short-term capital gains tax rate
Long-term capital gains tax rate
Algorithm used for tax lot selection
AVG_COST - Avg CostFIFO - FifoLIFO - LifoOPTIMAL - OptimalTLH - TlhUNAWARE - UnawareAVG_COST, FIFO, LIFO, OPTIMAL, TLH, UNAWARE Maximum acceptable tracking error threshold
Wash sale threshold in days
0 <= x <= 2147483647Long-term threshold in days
0 <= x <= 2147483647Ordinary income tax rate
Number of high loss lots to consider
0 <= x <= 2147483647Tax gamma parameter for tax optimization
Show child attributes
Show child attributes
Show child attributes
255IN_PROGRESS - In ProgressSUBMITTED - SubmittedAPPROVED - ApprovedREJECTED - RejectedIN_PROGRESS, SUBMITTED, APPROVED, REJECTED Whether to impact assets that are not part of the benchmark.
Whether the tilted weight should be considered part of the benchmark weights.
Show child attributes
255Optimization mode to use for portfolio optimization, this can be LONG_ONLY, LONG_SHORT, or LONG_BIASED.
LONG_ONLY - Long OnlyLONG_SHORT - Long ShortLONG_BIASED - Long BiasedLONG_ONLY, LONG_SHORT, LONG_BIASED Target sum of long weights for LONG_SHORT or LONG_BIASED optimization modes (e.g., 2.5 for 250% long).
Target sum of short weights for LONG_SHORT or LONG_BIASED optimization modes (e.g., -2.5 for -250% short).
Risk model to use for portfolio optimization
custom - Custompca - Pcacharacteristics - Characteristicscustom, pca, characteristics Show child attributes
Show child attributes
255IN_PROGRESS - In ProgressSUBMITTED - SubmittedAPPROVED - ApprovedREJECTED - RejectedIN_PROGRESS, SUBMITTED, APPROVED, REJECTED Show child attributes
Show child attributes
The date from which the ticker should no longer be held.
The date at which the ticker may be held again.
Show child attributes
Show child attributes
The date from which the ticker should no longer be traded.
The date at which the ticker may be traded again.
Show child attributes
Show child attributes
Show child attributes
128Show child attributes
Tax region for tax calculation
USA - UsaCANADA - CanadaUSA, CANADA Short-term capital gains tax rate
Long-term capital gains tax rate
Algorithm used for tax lot selection
AVG_COST - Avg CostFIFO - FifoLIFO - LifoOPTIMAL - OptimalTLH - TlhUNAWARE - UnawareAVG_COST, FIFO, LIFO, OPTIMAL, TLH, UNAWARE Maximum acceptable tracking error threshold
Wash sale threshold in days
0 <= x <= 2147483647Long-term threshold in days
0 <= x <= 2147483647Ordinary income tax rate
Number of high loss lots to consider
0 <= x <= 2147483647Tax gamma parameter for tax optimization
Show child attributes
Show child attributes
Show child attributes
255IN_PROGRESS - In ProgressSUBMITTED - SubmittedAPPROVED - ApprovedREJECTED - RejectedIN_PROGRESS, SUBMITTED, APPROVED, REJECTED Whether to impact assets that are not part of the benchmark.
Whether the tilted weight should be considered part of the benchmark weights.