# Private Markets ## Get SPV `$ clst v1:private-markets get-spv-by-id` **get** `/v1/private-markets/spvs/{spv_id}` Fetch one private-market SPV's complete economics and fee schedule. Requires the account holder to have attested. Returns `404` unless the SPV is `OPEN` and attached to a currently visible `ACTIVE` offering. ### Parameters - `--spv-id: string` SPV identifier. - `--account-id: number` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `V1PrivateMarketGetSpvByIDResponse: BaseResponse` - `data: object { id, company_id, currency, 20 more }` An OPEN SPV's identity, exact economics, and typed fee schedule. - `id: string` Stable SPV identifier. - `company_id: string` Company whose shares the vehicle holds. - `currency: "USD"` Terms currency. - `"USD"` - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `all_in_price_per_share: optional string` Price per share including fees. - `custodian_name: optional string` Custodian. - `fee_per_share: optional string` Per-share fee. - `fee_terms: optional array of SpvFeeTermResource` Typed fee schedule. - `charged_by: "FUND_MANAGER" or "CLEAR_STREET" or "THIRD_PARTY"` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: "USD"` Terms currency. - `"USD"` - `description: string` Plain-text fee disclosure. - `fee_type: "MANAGEMENT" or "CARRY" or "PLACEMENT" or 2 more` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: "ONE_TIME" or "ANNUAL" or "AT_EXIT" or "PASS_THROUGH"` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: optional string` Exact fixed amount, when amount-based. - `duration_years: optional string` Charge duration in years, when specified. - `hurdle_rate: optional string` Carry hurdle as a decimal fraction, when specified. - `rate: optional string` Decimal fraction between zero and one, when percentage-based. - `funded_percent: optional string` Percentage of dollar allocation funded, derived from the allocation pair. - `funding_deadline: optional string` Funding deadline. - `manager_name: optional string` SPV manager. - `minimum_investment_amount: optional string` Minimum investment amount. - `opened_at: optional string` Time the vehicle opened. - `price_per_share: optional string` Price per share excluding fees. - `remaining_allocation_amount: optional string` Remaining dollar allocation. - `remaining_share_allocation: optional string` Remaining share allocation. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. - `total_allocation_amount: optional string` Total dollar allocation. - `total_share_allocation: optional string` Total share allocation. - `valuation: optional string` Exact company valuation. - `valuation_basis: optional "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of `valuation`. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Example ```cli clst v1:private-markets get-spv-by-id \ --api-key 'My API Key' \ --spv-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \ --account-id 0 ``` #### Response ```json { "data": { "all_in_price_per_share": "102.5", "company_id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "currency": "USD", "custodian_name": "Clear Street LLC", "fee_per_share": "2.5", "funded_percent": "70", "id": "c3c4c5c6-d3d4-e3e4-f3f4-f5f6f7f8f9f0", "manager_name": "Clear Street Ventures", "minimum_investment_amount": "25000", "name": "Acme Robotics SPV III", "price_per_share": "100", "remaining_allocation_amount": "1500000", "remaining_share_allocation": "15000", "share_class": "Series D", "status": "OPEN", "total_allocation_amount": "5000000", "total_share_allocation": "50000", "valuation": "5000000000", "valuation_basis": "PRE_MONEY" }, "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## List every live IOI for the caller's account-holder entity. `$ clst v1:private-markets get-iois` **get** `/v1/private-markets/iois` List every live IOI for the caller's account-holder entity. ### Parameters - `--account-id: number` ### Returns - `V1PrivateMarketGetIoisResponse: BaseResponse` - `data: array of IoiListingResource` - `company: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` - `offering: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Example ```cli clst v1:private-markets get-iois \ --api-key 'My API Key' \ --account-id 0 ``` #### Response ```json { "data": [ { "account_id": 19816, "company": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics" }, "created_at": "2026-05-30T02:37:10.709695Z", "currency": "USD", "id": "019dbae9-73b4-7760-a947-8b4bcab57c49", "notional_amount": "100000.00", "offering": { "headline": "Series D opportunity", "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8" }, "offering_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "updated_at": "2026-05-30T02:37:10.709695Z" } ], "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## Create an IOI for a visible upcoming offering. `$ clst v1:private-markets create-ioi` **post** `/v1/private-markets/iois` Create an IOI for a visible upcoming offering. ### Parameters - `--account-id: number` Query param - `--notional-amount: string` Body param - `--offering-id: string` Body param - `--nda-acceptance: optional object { accepted, agreement_id, authority_confirmed }` Body param: Required only when the offering's attached SPV has an NDA agreement. ### Returns - `V1PrivateMarketNewIoiResponse: BaseResponse` - `data: IoiResource` IOI list item with the campaign identity needed to render it. - `company: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` - `offering: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Example ```cli clst v1:private-markets create-ioi \ --api-key 'My API Key' \ --account-id 0 \ --notional-amount 100000.00 \ --offering-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e ``` #### Response ```json { "data": { "account_id": 19816, "company": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics" }, "created_at": "2026-05-30T02:37:10.709695Z", "currency": "USD", "id": "019dbae9-73b4-7760-a947-8b4bcab57c49", "notional_amount": "100000.00", "offering": { "headline": "Series D opportunity", "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8" }, "offering_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "updated_at": "2026-05-30T02:37:10.709695Z" }, "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## Update an IOI's notional, accepting the current NDA revision when required. `$ clst v1:private-markets update-ioi` **patch** `/v1/private-markets/iois/{ioi_id}` Update an IOI's notional, accepting the current NDA revision when required. ### Parameters - `--ioi-id: string` Path param: IOI id - `--account-id: number` Query param - `--notional-amount: string` Body param - `--nda-acceptance: optional object { accepted, agreement_id, authority_confirmed }` Body param: Required when the SPV's current NDA version is newer than the IOI's latest acceptance. Irrelevant acceptances are rejected. ### Returns - `V1PrivateMarketUpdateIoiResponse: BaseResponse` - `data: IoiResource` IOI list item with the campaign identity needed to render it. - `company: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` - `offering: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Example ```cli clst v1:private-markets update-ioi \ --api-key 'My API Key' \ --ioi-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \ --account-id 0 \ --notional-amount 125000.00 ``` #### Response ```json { "data": { "account_id": 19816, "company": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics" }, "created_at": "2026-05-30T02:37:10.709695Z", "currency": "USD", "id": "019dbae9-73b4-7760-a947-8b4bcab57c49", "notional_amount": "125000.00", "offering": { "headline": "Series D opportunity", "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8" }, "offering_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "updated_at": "2026-05-30T03:12:44.001000Z" }, "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## Withdraw a live IOI. Repeating a withdrawal returns 404. `$ clst v1:private-markets delete-ioi` **delete** `/v1/private-markets/iois/{ioi_id}` Withdraw a live IOI. Repeating a withdrawal returns 404. ### Parameters - `--ioi-id: string` IOI id - `--account-id: number` ### Example ```cli clst v1:private-markets delete-ioi \ --api-key 'My API Key' \ --ioi-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \ --account-id 0 ``` ## Get Company `$ clst v1:private-markets get-company-by-id` **get** `/v1/private-markets/companies/{company_id}` Fetch one published private-market company with its complete versioned profile. Requires the account holder to have attested. Returns `404` when the company does not exist or is not yet published. ### Parameters - `--company-id: string` Company identifier. - `--account-id: number` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `V1PrivateMarketGetCompanyByIDResponse: BaseResponse` - `data: object { id, name, profile, 6 more }` A company's identity and its complete published profile. - `id: string` Stable company identifier. - `name: string` Display name. - `profile: object { categories, citations, customers, 9 more }` The complete versioned company profile. - `categories: optional array of CompanyCategory` Company categories. - `name: string` Display name. - `slug: string` Stable lowercase category slug. - `citations: optional array of CompanyCitation` Sources referenced by narrative sections and metrics. - `id: string` Stable profile-local citation identifier. - `source: string` Source publisher or provider. - `title: string` Human-readable source title. - `url: string` Source URL. - `published_at: optional string` Source publication time, when known. - `customers: optional array of CompanyCustomer` Named customers evidenced by the source material. - `name: string` Customer name. - `logo_url: optional string` Customer logo, when supplied. - `documents: optional array of CompanyDocumentResource` Company-level research and source documents. - `document_type: "COMPANY_PROFILE" or "MARKET_RESEARCH" or "INTERVIEW" or 4 more` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: "SUBJECT" or "CONNECTED"` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: string` Display title. - `url: string` Document URL. - `external_id: optional string` Optional source identifier retained for reconciliation. - `preview: optional object { description, image_url }` Optional card preview. - `description: optional string` Preview description. - `image_url: optional string` Preview image URL. - `published_at: optional string` Publication time, when known. - `headquarters: optional object { city, country }` Company headquarters, when known. - `city: string` City. - `country: string` Country. - `legal_entities: optional array of CompanyLegalEntity` Known legal entities associated with the company. - `country: string` Country name or ISO country code supplied by the source. - `name: string` Legal name. - `metric_series: optional array of CompanyMetricSeries` Historical and estimated metric series. - `frequency: "YEAR" or "QUARTER" or "MONTH" or "POINT_IN_TIME"` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: string` Display label. - `metric_key: "ANNUALIZED_REVENUE" or "REVENUE_GROWTH" or "VALUATION" or 12 more` Canonical metric key. - `"ANNUALIZED_REVENUE"` - `"REVENUE_GROWTH"` - `"VALUATION"` - `"ISSUE_PRICE"` - `"PRICE_PER_SHARE"` - `"AMOUNT_RAISED"` - `"ORDER_VOLUME"` - `"PIPELINE_VALUE"` - `"GROSS_MARGIN"` - `"EBIT_MARGIN"` - `"FCF_CONVERSION"` - `"CONTRACTED_REVENUE_PERCENT"` - `"NET_REVENUE_RETENTION"` - `"CUSTOMER_COUNT"` - `"MARKET_POSITION"` - `source: string` Publisher/provider name. - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: optional string` Optional source identifier retained for reconciliation. - `points: optional array of CompanyMetricPoint` Ordered observations. - `observed_at: string` Observation time. - `value: string` Exact decimal value, serialized as a string. - `value_type: "HISTORICAL" or "ESTIMATED"` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: optional array of string` Profile-local citation ids supporting this point. - `source_event_id: optional string` Optional source event identifier. - `source_metadata: optional map[string]` Optional provider reconciliation metadata. - `source_url: optional string` Source URL, when available. - `narrative_sections: optional array of CompanyNarrativeSection` Ordered durable company fact and thesis blocks. - `body: string` Plain-text section body. - `display_order: number` Stable display position within the profile. - `title: string` Section heading. - `citation_ids: optional array of string` Profile-local citation ids supporting this block. - `overview: optional string` Long company overview. - `people: optional array of CompanyPerson` Key people and their roles. - `name: string` Display name. - `external_id: optional string` Optional source identifier retained for reconciliation. - `roles: optional array of CompanyPersonRole` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: optional array of CompanySocialLink` Social/profile links. - `type: "WEBSITE" or "LINKEDIN" or "X" or 2 more` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: string` Link URL. - `tagline: optional string` Short durable positioning line used with the company name. - `profile_schema_version: number` Profile schema version discriminator. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. - `published_at: optional string` Publication time. ### Example ```cli clst v1:private-markets get-company-by-id \ --api-key 'My API Key' \ --company-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \ --account-id 0 ``` #### Response ```json { "data": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics", "profile": { "overview": "Acme Robotics builds autonomous material-handling systems for manufacturers.", "tagline": "Automating the factory floor." }, "profile_schema_version": 1, "short_description": "Industrial automation.", "slug": "acme-robotics" }, "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` # Companies ## Domain Types ### Company Category - `company_category: object { name, slug }` A company category. - `name: string` Display name. - `slug: string` Stable lowercase category slug. ### Company Citation - `company_citation: object { id, source, title, 2 more }` A cited source. - `id: string` Stable profile-local citation identifier. - `source: string` Source publisher or provider. - `title: string` Human-readable source title. - `url: string` Source URL. - `published_at: optional string` Source publication time, when known. ### Company Customer - `company_customer: object { name, logo_url }` A named company customer. - `name: string` Customer name. - `logo_url: optional string` Customer logo, when supplied. ### Company Detail - `company_detail: object { id, name, profile, 6 more }` A company's identity and its complete published profile. - `id: string` Stable company identifier. - `name: string` Display name. - `profile: object { categories, citations, customers, 9 more }` The complete versioned company profile. - `categories: optional array of CompanyCategory` Company categories. - `name: string` Display name. - `slug: string` Stable lowercase category slug. - `citations: optional array of CompanyCitation` Sources referenced by narrative sections and metrics. - `id: string` Stable profile-local citation identifier. - `source: string` Source publisher or provider. - `title: string` Human-readable source title. - `url: string` Source URL. - `published_at: optional string` Source publication time, when known. - `customers: optional array of CompanyCustomer` Named customers evidenced by the source material. - `name: string` Customer name. - `logo_url: optional string` Customer logo, when supplied. - `documents: optional array of CompanyDocumentResource` Company-level research and source documents. - `document_type: "COMPANY_PROFILE" or "MARKET_RESEARCH" or "INTERVIEW" or 4 more` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: "SUBJECT" or "CONNECTED"` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: string` Display title. - `url: string` Document URL. - `external_id: optional string` Optional source identifier retained for reconciliation. - `preview: optional object { description, image_url }` Optional card preview. - `description: optional string` Preview description. - `image_url: optional string` Preview image URL. - `published_at: optional string` Publication time, when known. - `headquarters: optional object { city, country }` Company headquarters, when known. - `city: string` City. - `country: string` Country. - `legal_entities: optional array of CompanyLegalEntity` Known legal entities associated with the company. - `country: string` Country name or ISO country code supplied by the source. - `name: string` Legal name. - `metric_series: optional array of CompanyMetricSeries` Historical and estimated metric series. - `frequency: "YEAR" or "QUARTER" or "MONTH" or "POINT_IN_TIME"` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: string` Display label. - `metric_key: "ANNUALIZED_REVENUE" or "REVENUE_GROWTH" or "VALUATION" or 12 more` Canonical metric key. - `"ANNUALIZED_REVENUE"` - `"REVENUE_GROWTH"` - `"VALUATION"` - `"ISSUE_PRICE"` - `"PRICE_PER_SHARE"` - `"AMOUNT_RAISED"` - `"ORDER_VOLUME"` - `"PIPELINE_VALUE"` - `"GROSS_MARGIN"` - `"EBIT_MARGIN"` - `"FCF_CONVERSION"` - `"CONTRACTED_REVENUE_PERCENT"` - `"NET_REVENUE_RETENTION"` - `"CUSTOMER_COUNT"` - `"MARKET_POSITION"` - `source: string` Publisher/provider name. - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: optional string` Optional source identifier retained for reconciliation. - `points: optional array of CompanyMetricPoint` Ordered observations. - `observed_at: string` Observation time. - `value: string` Exact decimal value, serialized as a string. - `value_type: "HISTORICAL" or "ESTIMATED"` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: optional array of string` Profile-local citation ids supporting this point. - `source_event_id: optional string` Optional source event identifier. - `source_metadata: optional map[string]` Optional provider reconciliation metadata. - `source_url: optional string` Source URL, when available. - `narrative_sections: optional array of CompanyNarrativeSection` Ordered durable company fact and thesis blocks. - `body: string` Plain-text section body. - `display_order: number` Stable display position within the profile. - `title: string` Section heading. - `citation_ids: optional array of string` Profile-local citation ids supporting this block. - `overview: optional string` Long company overview. - `people: optional array of CompanyPerson` Key people and their roles. - `name: string` Display name. - `external_id: optional string` Optional source identifier retained for reconciliation. - `roles: optional array of CompanyPersonRole` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: optional array of CompanySocialLink` Social/profile links. - `type: "WEBSITE" or "LINKEDIN" or "X" or 2 more` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: string` Link URL. - `tagline: optional string` Short durable positioning line used with the company name. - `profile_schema_version: number` Profile schema version discriminator. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. - `published_at: optional string` Publication time. ### Company Document Preview - `company_document_preview: object { description, image_url }` Optional document card preview. - `description: optional string` Preview description. - `image_url: optional string` Preview image URL. ### Company Document Relation - `company_document_relation: "SUBJECT" or "CONNECTED"` How a document relates to the company. - `"SUBJECT"` - `"CONNECTED"` ### Company Document Resource - `company_document_resource: object { document_type, relation, title, 4 more }` A company-level research or source document. - `document_type: "COMPANY_PROFILE" or "MARKET_RESEARCH" or "INTERVIEW" or 4 more` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: "SUBJECT" or "CONNECTED"` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: string` Display title. - `url: string` Document URL. - `external_id: optional string` Optional source identifier retained for reconciliation. - `preview: optional object { description, image_url }` Optional card preview. - `description: optional string` Preview description. - `image_url: optional string` Preview image URL. - `published_at: optional string` Publication time, when known. ### Company Document Type - `company_document_type: "COMPANY_PROFILE" or "MARKET_RESEARCH" or "INTERVIEW" or 4 more` Company document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` ### Company Headquarters - `company_headquarters: object { city, country }` Company headquarters. - `city: string` City. - `country: string` Country. ### Company Legal Entity - `company_legal_entity: object { country, name }` A legal entity associated with the company. - `country: string` Country name or ISO country code supplied by the source. - `name: string` Legal name. ### Company Metric Point - `company_metric_point: object { observed_at, value, value_type, 3 more }` One metric observation. - `observed_at: string` Observation time. - `value: string` Exact decimal value, serialized as a string. - `value_type: "HISTORICAL" or "ESTIMATED"` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: optional array of string` Profile-local citation ids supporting this point. - `source_event_id: optional string` Optional source event identifier. - `source_metadata: optional map[string]` Optional provider reconciliation metadata. ### Company Metric Series - `company_metric_series: object { frequency, label, metric_key, 5 more }` A historical or estimated company metric series. - `frequency: "YEAR" or "QUARTER" or "MONTH" or "POINT_IN_TIME"` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: string` Display label. - `metric_key: "ANNUALIZED_REVENUE" or "REVENUE_GROWTH" or "VALUATION" or 12 more` Canonical metric key. - `"ANNUALIZED_REVENUE"` - `"REVENUE_GROWTH"` - `"VALUATION"` - `"ISSUE_PRICE"` - `"PRICE_PER_SHARE"` - `"AMOUNT_RAISED"` - `"ORDER_VOLUME"` - `"PIPELINE_VALUE"` - `"GROSS_MARGIN"` - `"EBIT_MARGIN"` - `"FCF_CONVERSION"` - `"CONTRACTED_REVENUE_PERCENT"` - `"NET_REVENUE_RETENTION"` - `"CUSTOMER_COUNT"` - `"MARKET_POSITION"` - `source: string` Publisher/provider name. - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: optional string` Optional source identifier retained for reconciliation. - `points: optional array of CompanyMetricPoint` Ordered observations. - `observed_at: string` Observation time. - `value: string` Exact decimal value, serialized as a string. - `value_type: "HISTORICAL" or "ESTIMATED"` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: optional array of string` Profile-local citation ids supporting this point. - `source_event_id: optional string` Optional source event identifier. - `source_metadata: optional map[string]` Optional provider reconciliation metadata. - `source_url: optional string` Source URL, when available. ### Company Narrative Section - `company_narrative_section: object { body, display_order, title, citation_ids }` One ordered durable narrative block. - `body: string` Plain-text section body. - `display_order: number` Stable display position within the profile. - `title: string` Section heading. - `citation_ids: optional array of string` Profile-local citation ids supporting this block. ### Company Person - `company_person: object { name, external_id, roles }` A key person associated with the company. - `name: string` Display name. - `external_id: optional string` Optional source identifier retained for reconciliation. - `roles: optional array of CompanyPersonRole` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` ### Company Person Role - `company_person_role: "FOUNDER" or "CEO" or "OTHER"` A key person's relationship to the company. - `"FOUNDER"` - `"CEO"` - `"OTHER"` ### Company Profile Resource - `company_profile_resource: object { categories, citations, customers, 9 more }` The complete versioned company profile (schema version one). - `categories: optional array of CompanyCategory` Company categories. - `name: string` Display name. - `slug: string` Stable lowercase category slug. - `citations: optional array of CompanyCitation` Sources referenced by narrative sections and metrics. - `id: string` Stable profile-local citation identifier. - `source: string` Source publisher or provider. - `title: string` Human-readable source title. - `url: string` Source URL. - `published_at: optional string` Source publication time, when known. - `customers: optional array of CompanyCustomer` Named customers evidenced by the source material. - `name: string` Customer name. - `logo_url: optional string` Customer logo, when supplied. - `documents: optional array of CompanyDocumentResource` Company-level research and source documents. - `document_type: "COMPANY_PROFILE" or "MARKET_RESEARCH" or "INTERVIEW" or 4 more` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: "SUBJECT" or "CONNECTED"` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: string` Display title. - `url: string` Document URL. - `external_id: optional string` Optional source identifier retained for reconciliation. - `preview: optional object { description, image_url }` Optional card preview. - `description: optional string` Preview description. - `image_url: optional string` Preview image URL. - `published_at: optional string` Publication time, when known. - `headquarters: optional object { city, country }` Company headquarters, when known. - `city: string` City. - `country: string` Country. - `legal_entities: optional array of CompanyLegalEntity` Known legal entities associated with the company. - `country: string` Country name or ISO country code supplied by the source. - `name: string` Legal name. - `metric_series: optional array of CompanyMetricSeries` Historical and estimated metric series. - `frequency: "YEAR" or "QUARTER" or "MONTH" or "POINT_IN_TIME"` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: string` Display label. - `metric_key: "ANNUALIZED_REVENUE" or "REVENUE_GROWTH" or "VALUATION" or 12 more` Canonical metric key. - `"ANNUALIZED_REVENUE"` - `"REVENUE_GROWTH"` - `"VALUATION"` - `"ISSUE_PRICE"` - `"PRICE_PER_SHARE"` - `"AMOUNT_RAISED"` - `"ORDER_VOLUME"` - `"PIPELINE_VALUE"` - `"GROSS_MARGIN"` - `"EBIT_MARGIN"` - `"FCF_CONVERSION"` - `"CONTRACTED_REVENUE_PERCENT"` - `"NET_REVENUE_RETENTION"` - `"CUSTOMER_COUNT"` - `"MARKET_POSITION"` - `source: string` Publisher/provider name. - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: optional string` Optional source identifier retained for reconciliation. - `points: optional array of CompanyMetricPoint` Ordered observations. - `observed_at: string` Observation time. - `value: string` Exact decimal value, serialized as a string. - `value_type: "HISTORICAL" or "ESTIMATED"` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: optional array of string` Profile-local citation ids supporting this point. - `source_event_id: optional string` Optional source event identifier. - `source_metadata: optional map[string]` Optional provider reconciliation metadata. - `source_url: optional string` Source URL, when available. - `narrative_sections: optional array of CompanyNarrativeSection` Ordered durable company fact and thesis blocks. - `body: string` Plain-text section body. - `display_order: number` Stable display position within the profile. - `title: string` Section heading. - `citation_ids: optional array of string` Profile-local citation ids supporting this block. - `overview: optional string` Long company overview. - `people: optional array of CompanyPerson` Key people and their roles. - `name: string` Display name. - `external_id: optional string` Optional source identifier retained for reconciliation. - `roles: optional array of CompanyPersonRole` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: optional array of CompanySocialLink` Social/profile links. - `type: "WEBSITE" or "LINKEDIN" or "X" or 2 more` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: string` Link URL. - `tagline: optional string` Short durable positioning line used with the company name. ### Company Social Link - `company_social_link: object { type, url }` A company social/profile link. - `type: "WEBSITE" or "LINKEDIN" or "X" or 2 more` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: string` Link URL. ### Company Social Type - `company_social_type: "WEBSITE" or "LINKEDIN" or "X" or 2 more` Kind of company social/profile link. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` ### Metric Frequency - `metric_frequency: "YEAR" or "QUARTER" or "MONTH" or "POINT_IN_TIME"` Observation cadence for a metric series. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` ### Metric Key - `metric_key: "ANNUALIZED_REVENUE" or "REVENUE_GROWTH" or "VALUATION" or 12 more` Canonical company metric key. - `"ANNUALIZED_REVENUE"` - `"REVENUE_GROWTH"` - `"VALUATION"` - `"ISSUE_PRICE"` - `"PRICE_PER_SHARE"` - `"AMOUNT_RAISED"` - `"ORDER_VOLUME"` - `"PIPELINE_VALUE"` - `"GROSS_MARGIN"` - `"EBIT_MARGIN"` - `"FCF_CONVERSION"` - `"CONTRACTED_REVENUE_PERCENT"` - `"NET_REVENUE_RETENTION"` - `"CUSTOMER_COUNT"` - `"MARKET_POSITION"` # Iois ## Domain Types ### Ioi Company Resource - `ioi_company_resource: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` ### Ioi Listing Resource - `ioi_listing_resource: IoiResource` IOI list item with the campaign identity needed to render it. - `company: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` - `offering: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Ioi Listing Resource List - `ioi_listing_resource_list: array of IoiListingResource` - `company: object { id, name }` Company identity embedded in an IOI list item. - `id: string` - `name: string` - `offering: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Ioi Offering Resource - `ioi_offering_resource: object { id, headline }` Offering identity embedded in an IOI list item. - `id: string` - `headline: string` ### Ioi Resource - `ioi_resource: object { id, account_id, created_at, 5 more }` One live indication of interest. - `id: string` - `account_id: number` - `created_at: string` - `currency: "USD"` Terms currency. - `"USD"` - `notional_amount: string` - `offering_id: string` - `updated_at: string` - `nda_acceptance: optional object { accepted_at, agreement_id, version }` Most recent NDA acceptance linked to this IOI, if any. - `accepted_at: string` - `agreement_id: string` - `version: number` ### Nda Acceptance Resource - `nda_acceptance_resource: object { accepted_at, agreement_id, version }` Public evidence that an NDA version was accepted. Signing IP and other provenance remain audit-only and are never returned by this API. - `accepted_at: string` - `agreement_id: string` - `version: number` # Offerings ## List Offerings `$ clst v1:private-markets:offerings get-offerings` **get** `/v1/private-markets/offerings` List every visible private-market offering as a card, with its derived class, company and SPV identity, and indicative terms. Requires the account holder to have attested. ### Parameters - `--account-id: number` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `V1PrivateMarketOfferingGetOfferingsResponse: BaseResponse` - `data: array of OfferingCard` - `id: string` Stable public identifier; IOIs and history hang off it. - `class: "UPCOMING" or "ACTIVE"` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: object { id, name, short_description, 3 more }` Owning company identity. - `id: string` Stable company identifier. - `name: string` Display name. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. - `currency: "USD"` Terms currency. - `"USD"` - `headline: string` Card/detail headline. - `summary: string` Top opportunity paragraph. - `indicative_price_high: optional string` Indicative price-per-share range, high endpoint. - `indicative_price_low: optional string` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: optional "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: optional string` Indicative valuation range, high endpoint. - `indicative_valuation_low: optional string` Indicative valuation range, low endpoint. - `ioi_deadline: optional string` Deadline for indications of interest. - `minimum_ioi_amount: optional string` Minimum indication-of-interest amount. - `spv: optional object { id, name, status, 5 more }` Attached SPV identity and lifecycle, once one exists. - `id: string` Stable SPV identifier. - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: optional string` Custodian. - `manager_name: optional string` SPV manager. - `nda_agreement: optional object { acceptance_text, acceptance_text_version, agreement_id, 4 more }` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: string` Exact assent and authority representation shown to the signer. - `acceptance_text_version: number` Version of the acceptance representation. - `agreement_id: string` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: string` Durable reference to the immutable NDA artifact. - `document_sha256: string` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: string` Time this version became effective. - `version: number` Strictly increasing SPV-local agreement version. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. ### Example ```cli clst v1:private-markets:offerings get-offerings \ --api-key 'My API Key' \ --account-id 0 ``` #### Response ```json { "data": [ { "class": "ACTIVE", "company": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics", "short_description": "Industrial automation.", "slug": "acme-robotics" }, "currency": "USD", "headline": "Series D opportunity", "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "indicative_price_high": "110", "indicative_price_low": "90", "minimum_ioi_amount": "25000", "summary": "Late-stage growth company opening an SPV round." } ], "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## Get Offering `$ clst v1:private-markets:offerings get-offering-by-id` **get** `/v1/private-markets/offerings/{offering_id}` Fetch one visible private-market offering with its documents, participants, and any attached SPV. Requires the account holder to have attested. Returns `404` when the offering does not exist or is not currently visible. ### Parameters - `--offering-id: string` Offering identifier. - `--account-id: number` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `V1PrivateMarketOfferingGetOfferingByIDResponse: BaseResponse` - `data: OfferingCard` One offering with everything needed to render its detail payload. - `disclosures: optional string` Important disclosures. - `documents: optional array of OfferingDocumentResource` Campaign documents in display order. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `document_type: "TEARSHEET" or "KEY_TERMS" or "RISK_FACTORS" or 2 more` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: string` Display title. - `object_key: optional string` Object-store key, when the document is stored internally. - `published_at: optional string` Publication time, when known. - `source: optional string` Source publisher/provider. - `source_url: optional string` Source URL. - `url: optional string` Externally reachable URL, when the document lives at one. - `highlights: optional array of OfferingHighlight` Ordered resolved highlights. - `label: string` Display label (the highlight's override, else the series' own label). - `metric_key: string` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: optional string` Observation time of the latest value. - `value: optional string` Latest observed value, when the series carries any points. - `value_type: optional "HISTORICAL" or "ESTIMATED"` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` - `investment_thesis: optional string` Campaign-specific investment framing. - `key_risks: optional array of OfferingKeyRisk` Ordered key risks. - `body: string` Plain-text risk body. - `title: string` Risk heading. - `citation_ids: optional array of string` Profile-local citation ids supporting the risk. - `participants: optional array of OfferingParticipantResource` Campaign participants in display order. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `name: string` Display name. - `role: "LEAD_INVESTOR" or "CO_LEAD" or "FUND_MANAGER" or "PLACEMENT_AGENT"` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` - `structure_description: optional string` Vehicle/structure framing shown before typed SPV terms exist. - `why_now: optional string` Why-now framing. ### Example ```cli clst v1:private-markets:offerings get-offering-by-id \ --api-key 'My API Key' \ --offering-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \ --account-id 0 ``` #### Response ```json { "data": { "class": "ACTIVE", "company": { "id": "b2b3b4b5-c2c3-d2d3-e2e3-e4e5e6e7e8e9", "name": "Acme Robotics", "short_description": "Industrial automation.", "slug": "acme-robotics" }, "currency": "USD", "headline": "Series D opportunity", "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "indicative_price_high": "110", "indicative_price_low": "90", "investment_thesis": "Category leader with expanding margins.", "minimum_ioi_amount": "25000", "summary": "Late-stage growth company opening an SPV round.", "why_now": "Closing its final growth round before an anticipated IPO." }, "error": null, "metadata": { "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f" } } ``` ## Domain Types ### Currency - `currency: "USD"` Terms currency. - `"USD"` ### Metric Unit - `metric_unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Unit for a resolved highlight metric. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` ### Metric Value Type - `metric_value_type: "HISTORICAL" or "ESTIMATED"` Whether a resolved highlight value is observed or estimated. - `"HISTORICAL"` - `"ESTIMATED"` ### Nda Agreement Resource - `nda_agreement_resource: object { acceptance_text, acceptance_text_version, agreement_id, 4 more }` Current NDA agreement for an SPV-backed deal. - `acceptance_text: string` Exact assent and authority representation shown to the signer. - `acceptance_text_version: number` Version of the acceptance representation. - `agreement_id: string` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: string` Durable reference to the immutable NDA artifact. - `document_sha256: string` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: string` Time this version became effective. - `version: number` Strictly increasing SPV-local agreement version. ### Offering Card - `offering_card: object { id, class, company, 11 more }` One offering as it appears in a list: its derived class, indicative terms, a company identity summary, and any attached SPV. - `id: string` Stable public identifier; IOIs and history hang off it. - `class: "UPCOMING" or "ACTIVE"` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: object { id, name, short_description, 3 more }` Owning company identity. - `id: string` Stable company identifier. - `name: string` Display name. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. - `currency: "USD"` Terms currency. - `"USD"` - `headline: string` Card/detail headline. - `summary: string` Top opportunity paragraph. - `indicative_price_high: optional string` Indicative price-per-share range, high endpoint. - `indicative_price_low: optional string` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: optional "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: optional string` Indicative valuation range, high endpoint. - `indicative_valuation_low: optional string` Indicative valuation range, low endpoint. - `ioi_deadline: optional string` Deadline for indications of interest. - `minimum_ioi_amount: optional string` Minimum indication-of-interest amount. - `spv: optional object { id, name, status, 5 more }` Attached SPV identity and lifecycle, once one exists. - `id: string` Stable SPV identifier. - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: optional string` Custodian. - `manager_name: optional string` SPV manager. - `nda_agreement: optional object { acceptance_text, acceptance_text_version, agreement_id, 4 more }` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: string` Exact assent and authority representation shown to the signer. - `acceptance_text_version: number` Version of the acceptance representation. - `agreement_id: string` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: string` Durable reference to the immutable NDA artifact. - `document_sha256: string` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: string` Time this version became effective. - `version: number` Strictly increasing SPV-local agreement version. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. ### Offering Card List - `offering_card_list: array of OfferingCard` - `id: string` Stable public identifier; IOIs and history hang off it. - `class: "UPCOMING" or "ACTIVE"` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: object { id, name, short_description, 3 more }` Owning company identity. - `id: string` Stable company identifier. - `name: string` Display name. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. - `currency: "USD"` Terms currency. - `"USD"` - `headline: string` Card/detail headline. - `summary: string` Top opportunity paragraph. - `indicative_price_high: optional string` Indicative price-per-share range, high endpoint. - `indicative_price_low: optional string` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: optional "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: optional string` Indicative valuation range, high endpoint. - `indicative_valuation_low: optional string` Indicative valuation range, low endpoint. - `ioi_deadline: optional string` Deadline for indications of interest. - `minimum_ioi_amount: optional string` Minimum indication-of-interest amount. - `spv: optional object { id, name, status, 5 more }` Attached SPV identity and lifecycle, once one exists. - `id: string` Stable SPV identifier. - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: optional string` Custodian. - `manager_name: optional string` SPV manager. - `nda_agreement: optional object { acceptance_text, acceptance_text_version, agreement_id, 4 more }` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: string` Exact assent and authority representation shown to the signer. - `acceptance_text_version: number` Version of the acceptance representation. - `agreement_id: string` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: string` Durable reference to the immutable NDA artifact. - `document_sha256: string` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: string` Time this version became effective. - `version: number` Strictly increasing SPV-local agreement version. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. ### Offering Class - `offering_class: "UPCOMING" or "ACTIVE"` Derived offering classification. - `"UPCOMING"` - `"ACTIVE"` ### Offering Company - `offering_company: object { id, name, short_description, 3 more }` Company identity carried on an offering card/detail. - `id: string` Stable company identifier. - `name: string` Display name. - `short_description: string` Short card/search description. - `slug: string` Lowercase URL slug. - `logo_url: optional string` Company logo URL, when known. - `primary_domain: optional string` Canonical lowercase domain, when known. ### Offering Detail - `offering_detail: OfferingCard` One offering with everything needed to render its detail payload. - `disclosures: optional string` Important disclosures. - `documents: optional array of OfferingDocumentResource` Campaign documents in display order. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `document_type: "TEARSHEET" or "KEY_TERMS" or "RISK_FACTORS" or 2 more` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: string` Display title. - `object_key: optional string` Object-store key, when the document is stored internally. - `published_at: optional string` Publication time, when known. - `source: optional string` Source publisher/provider. - `source_url: optional string` Source URL. - `url: optional string` Externally reachable URL, when the document lives at one. - `highlights: optional array of OfferingHighlight` Ordered resolved highlights. - `label: string` Display label (the highlight's override, else the series' own label). - `metric_key: string` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: optional string` Observation time of the latest value. - `value: optional string` Latest observed value, when the series carries any points. - `value_type: optional "HISTORICAL" or "ESTIMATED"` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` - `investment_thesis: optional string` Campaign-specific investment framing. - `key_risks: optional array of OfferingKeyRisk` Ordered key risks. - `body: string` Plain-text risk body. - `title: string` Risk heading. - `citation_ids: optional array of string` Profile-local citation ids supporting the risk. - `participants: optional array of OfferingParticipantResource` Campaign participants in display order. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `name: string` Display name. - `role: "LEAD_INVESTOR" or "CO_LEAD" or "FUND_MANAGER" or "PLACEMENT_AGENT"` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` - `structure_description: optional string` Vehicle/structure framing shown before typed SPV terms exist. - `why_now: optional string` Why-now framing. ### Offering Document Resource - `offering_document_resource: object { id, display_order, document_type, 6 more }` A campaign document's display metadata. Exactly one of `url`/`object_key` is set; an object key is resolved and signed elsewhere. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `document_type: "TEARSHEET" or "KEY_TERMS" or "RISK_FACTORS" or 2 more` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: string` Display title. - `object_key: optional string` Object-store key, when the document is stored internally. - `published_at: optional string` Publication time, when known. - `source: optional string` Source publisher/provider. - `source_url: optional string` Source URL. - `url: optional string` Externally reachable URL, when the document lives at one. ### Offering Document Type - `offering_document_type: "TEARSHEET" or "KEY_TERMS" or "RISK_FACTORS" or 2 more` Kind of campaign document. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` ### Offering Highlight - `offering_highlight: object { label, metric_key, unit, 3 more }` A curated highlight, resolved against the company profile's metric series. - `label: string` Display label (the highlight's override, else the series' own label). - `metric_key: string` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: "USD" or "PERCENT" or "COUNT" or "RANK"` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: optional string` Observation time of the latest value. - `value: optional string` Latest observed value, when the series carries any points. - `value_type: optional "HISTORICAL" or "ESTIMATED"` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` ### Offering Key Risk - `offering_key_risk: object { body, title, citation_ids }` One ordered key-risk block. - `body: string` Plain-text risk body. - `title: string` Risk heading. - `citation_ids: optional array of string` Profile-local citation ids supporting the risk. ### Offering Participant Resource - `offering_participant_resource: object { id, display_order, name, role }` An offering participant's display data. - `id: string` Stable identifier. - `display_order: number` Stable display position. - `name: string` Display name. - `role: "LEAD_INVESTOR" or "CO_LEAD" or "FUND_MANAGER" or "PLACEMENT_AGENT"` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` ### Offering Spv - `offering_spv: object { id, name, status, 5 more }` The attached SPV's identity and lifecycle. Exact economics surface once the SPV opens; an upcoming offering's indicative ranges describe the terms until then. - `id: string` Stable SPV identifier. - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: optional string` Custodian. - `manager_name: optional string` SPV manager. - `nda_agreement: optional object { acceptance_text, acceptance_text_version, agreement_id, 4 more }` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: string` Exact assent and authority representation shown to the signer. - `acceptance_text_version: number` Version of the acceptance representation. - `agreement_id: string` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: string` Durable reference to the immutable NDA artifact. - `document_sha256: string` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: string` Time this version became effective. - `version: number` Strictly increasing SPV-local agreement version. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. ### Participant Role - `participant_role: "LEAD_INVESTOR" or "CO_LEAD" or "FUND_MANAGER" or "PLACEMENT_AGENT"` Presentation role of an offering participant. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` ### Spv Status - `spv_status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` SPV lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` ### Valuation Basis - `valuation_basis: "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of an indicative valuation range or an SPV valuation. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` # Spvs ## Domain Types ### Charged By - `charged_by: "FUND_MANAGER" or "CLEAR_STREET" or "THIRD_PARTY"` Party charging a fee. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` ### Fee Frequency - `fee_frequency: "ONE_TIME" or "ANNUAL" or "AT_EXIT" or "PASS_THROUGH"` Fee timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` ### Fee Type - `fee_type: "MANAGEMENT" or "CARRY" or "PLACEMENT" or 2 more` Kind of SPV fee. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` ### Spv Detail - `spv_detail: object { id, company_id, currency, 20 more }` An OPEN SPV's identity, exact economics, and typed fee schedule. - `id: string` Stable SPV identifier. - `company_id: string` Company whose shares the vehicle holds. - `currency: "USD"` Terms currency. - `"USD"` - `name: string` Legal/display name. - `status: "DRAFT" or "OPEN" or "CLOSED" or 2 more` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `all_in_price_per_share: optional string` Price per share including fees. - `custodian_name: optional string` Custodian. - `fee_per_share: optional string` Per-share fee. - `fee_terms: optional array of SpvFeeTermResource` Typed fee schedule. - `charged_by: "FUND_MANAGER" or "CLEAR_STREET" or "THIRD_PARTY"` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: "USD"` Terms currency. - `"USD"` - `description: string` Plain-text fee disclosure. - `fee_type: "MANAGEMENT" or "CARRY" or "PLACEMENT" or 2 more` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: "ONE_TIME" or "ANNUAL" or "AT_EXIT" or "PASS_THROUGH"` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: optional string` Exact fixed amount, when amount-based. - `duration_years: optional string` Charge duration in years, when specified. - `hurdle_rate: optional string` Carry hurdle as a decimal fraction, when specified. - `rate: optional string` Decimal fraction between zero and one, when percentage-based. - `funded_percent: optional string` Percentage of dollar allocation funded, derived from the allocation pair. - `funding_deadline: optional string` Funding deadline. - `manager_name: optional string` SPV manager. - `minimum_investment_amount: optional string` Minimum investment amount. - `opened_at: optional string` Time the vehicle opened. - `price_per_share: optional string` Price per share excluding fees. - `remaining_allocation_amount: optional string` Remaining dollar allocation. - `remaining_share_allocation: optional string` Remaining share allocation. - `share_class: optional string` Underlying share class, when specified. - `structure_description: optional string` Plain-text vehicle structure. - `total_allocation_amount: optional string` Total dollar allocation. - `total_share_allocation: optional string` Total share allocation. - `valuation: optional string` Exact company valuation. - `valuation_basis: optional "PRE_MONEY" or "POST_MONEY" or "REFERENCE" or "IMPLIED"` Meaning of `valuation`. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Spv Fee Term Resource - `spv_fee_term_resource: object { charged_by, currency, description, 6 more }` One typed SPV fee term. - `charged_by: "FUND_MANAGER" or "CLEAR_STREET" or "THIRD_PARTY"` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: "USD"` Terms currency. - `"USD"` - `description: string` Plain-text fee disclosure. - `fee_type: "MANAGEMENT" or "CARRY" or "PLACEMENT" or 2 more` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: "ONE_TIME" or "ANNUAL" or "AT_EXIT" or "PASS_THROUGH"` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: optional string` Exact fixed amount, when amount-based. - `duration_years: optional string` Charge duration in years, when specified. - `hurdle_rate: optional string` Carry hurdle as a decimal fraction, when specified. - `rate: optional string` Decimal fraction between zero and one, when percentage-based.