# Private Markets ## Get SPV `v1.private_markets.get_spv_by_id(strspv_id, PrivateMarketGetSpvByIDParams**kwargs) -> PrivateMarketGetSpvByIDResponse` **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: str` - `account_id: int` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `class PrivateMarketGetSpvByIDResponse: …` - `data: SpvDetail` An OPEN SPV's identity, exact economics, and typed fee schedule. - `id: str` Stable SPV identifier. - `company_id: str` Company whose shares the vehicle holds. - `currency: Currency` Terms currency. - `"USD"` - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `all_in_price_per_share: Optional[str]` Price per share including fees. - `custodian_name: Optional[str]` Custodian. - `fee_per_share: Optional[str]` Per-share fee. - `fee_terms: Optional[List[SpvFeeTermResource]]` Typed fee schedule. - `charged_by: ChargedBy` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: Currency` Terms currency. - `description: str` Plain-text fee disclosure. - `fee_type: FeeType` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: FeeFrequency` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: Optional[str]` Exact fixed amount, when amount-based. - `duration_years: Optional[str]` Charge duration in years, when specified. - `hurdle_rate: Optional[str]` Carry hurdle as a decimal fraction, when specified. - `rate: Optional[str]` Decimal fraction between zero and one, when percentage-based. - `funded_percent: Optional[str]` Percentage of dollar allocation funded, derived from the allocation pair. - `funding_deadline: Optional[datetime]` Funding deadline. - `manager_name: Optional[str]` SPV manager. - `minimum_investment_amount: Optional[str]` Minimum investment amount. - `opened_at: Optional[datetime]` Time the vehicle opened. - `price_per_share: Optional[str]` Price per share excluding fees. - `remaining_allocation_amount: Optional[str]` Remaining dollar allocation. - `remaining_share_allocation: Optional[str]` Remaining share allocation. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. - `total_allocation_amount: Optional[str]` Total dollar allocation. - `total_share_allocation: Optional[str]` Total share allocation. - `valuation: Optional[str]` Exact company valuation. - `valuation_basis: Optional[ValuationBasis]` Meaning of `valuation`. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.get_spv_by_id( spv_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id=0, ) print(response) ``` #### 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. `v1.private_markets.get_iois(PrivateMarketGetIoisParams**kwargs) -> PrivateMarketGetIoisResponse` **get** `/v1/private-markets/iois` List every live IOI for the caller's account-holder entity. ### Parameters - `account_id: int` ### Returns - `class PrivateMarketGetIoisResponse: …` - `data: IoiListingResourceList` - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.get_iois( account_id=0, ) print(response) ``` #### 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. `v1.private_markets.create_ioi(PrivateMarketCreateIoiParams**kwargs) -> PrivateMarketCreateIoiResponse` **post** `/v1/private-markets/iois` Create an IOI for a visible upcoming offering. ### Parameters - `account_id: int` - `notional_amount: str` - `offering_id: str` - `nda_acceptance: Optional[NdaAcceptance]` Required only when the offering's attached SPV has an NDA agreement. - `accepted: bool` Must be true; confirms affirmative assent. - `agreement_id: str` Exact agreement id returned by offering detail. - `authority_confirmed: bool` Must be true; confirms the signer may bind the account-holder entity. ### Returns - `class PrivateMarketCreateIoiResponse: …` - `data: IoiListingResource` IOI list item with the campaign identity needed to render it. - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.create_ioi( account_id=0, notional_amount="100000.00", offering_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(response) ``` #### 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. `v1.private_markets.update_ioi(strioi_id, PrivateMarketUpdateIoiParams**kwargs) -> PrivateMarketUpdateIoiResponse` **patch** `/v1/private-markets/iois/{ioi_id}` Update an IOI's notional, accepting the current NDA revision when required. ### Parameters - `ioi_id: str` - `account_id: int` - `notional_amount: str` - `nda_acceptance: Optional[NdaAcceptance]` Required when the SPV's current NDA version is newer than the IOI's latest acceptance. Irrelevant acceptances are rejected. - `accepted: bool` Must be true; confirms affirmative assent. - `agreement_id: str` Exact agreement id returned by offering detail. - `authority_confirmed: bool` Must be true; confirms the signer may bind the account-holder entity. ### Returns - `class PrivateMarketUpdateIoiResponse: …` - `data: IoiListingResource` IOI list item with the campaign identity needed to render it. - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.update_ioi( ioi_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id=0, notional_amount="125000.00", ) print(response) ``` #### 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. `v1.private_markets.delete_ioi(strioi_id, PrivateMarketDeleteIoiParams**kwargs)` **delete** `/v1/private-markets/iois/{ioi_id}` Withdraw a live IOI. Repeating a withdrawal returns 404. ### Parameters - `ioi_id: str` - `account_id: int` ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) client.v1.private_markets.delete_ioi( ioi_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id=0, ) ``` ## Get Company `v1.private_markets.get_company_by_id(strcompany_id, PrivateMarketGetCompanyByIDParams**kwargs) -> PrivateMarketGetCompanyByIDResponse` **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: str` - `account_id: int` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `class PrivateMarketGetCompanyByIDResponse: …` - `data: CompanyDetail` A company's identity and its complete published profile. - `id: str` Stable company identifier. - `name: str` Display name. - `profile: CompanyProfileResource` The complete versioned company profile. - `categories: Optional[List[CompanyCategory]]` Company categories. - `name: str` Display name. - `slug: str` Stable lowercase category slug. - `citations: Optional[List[CompanyCitation]]` Sources referenced by narrative sections and metrics. - `id: str` Stable profile-local citation identifier. - `source: str` Source publisher or provider. - `title: str` Human-readable source title. - `url: str` Source URL. - `published_at: Optional[datetime]` Source publication time, when known. - `customers: Optional[List[CompanyCustomer]]` Named customers evidenced by the source material. - `name: str` Customer name. - `logo_url: Optional[str]` Customer logo, when supplied. - `documents: Optional[List[CompanyDocumentResource]]` Company-level research and source documents. - `document_type: CompanyDocumentType` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: CompanyDocumentRelation` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: str` Display title. - `url: str` Document URL. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `preview: Optional[CompanyDocumentPreview]` Optional card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. - `published_at: Optional[datetime]` Publication time, when known. - `headquarters: Optional[CompanyHeadquarters]` Company headquarters, when known. - `city: str` City. - `country: str` Country. - `legal_entities: Optional[List[CompanyLegalEntity]]` Known legal entities associated with the company. - `country: str` Country name or ISO country code supplied by the source. - `name: str` Legal name. - `metric_series: Optional[List[CompanyMetricSeries]]` Historical and estimated metric series. - `frequency: MetricFrequency` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: str` Display label. - `metric_key: MetricKey` 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: str` Publisher/provider name. - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `points: Optional[List[CompanyMetricPoint]]` Ordered observations. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. - `source_url: Optional[str]` Source URL, when available. - `narrative_sections: Optional[List[CompanyNarrativeSection]]` Ordered durable company fact and thesis blocks. - `body: str` Plain-text section body. - `display_order: int` Stable display position within the profile. - `title: str` Section heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this block. - `overview: Optional[str]` Long company overview. - `people: Optional[List[CompanyPerson]]` Key people and their roles. - `name: str` Display name. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `roles: Optional[List[CompanyPersonRole]]` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: Optional[List[CompanySocialLink]]` Social/profile links. - `type: CompanySocialType` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: str` Link URL. - `tagline: Optional[str]` Short durable positioning line used with the company name. - `profile_schema_version: int` Profile schema version discriminator. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `published_at: Optional[datetime]` Publication time. ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.get_company_by_id( company_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id=0, ) print(response) ``` #### 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" } } ``` ## Domain Types ### Private Market Get Spv By ID Response - `class PrivateMarketGetSpvByIDResponse: …` - `data: SpvDetail` An OPEN SPV's identity, exact economics, and typed fee schedule. - `id: str` Stable SPV identifier. - `company_id: str` Company whose shares the vehicle holds. - `currency: Currency` Terms currency. - `"USD"` - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `all_in_price_per_share: Optional[str]` Price per share including fees. - `custodian_name: Optional[str]` Custodian. - `fee_per_share: Optional[str]` Per-share fee. - `fee_terms: Optional[List[SpvFeeTermResource]]` Typed fee schedule. - `charged_by: ChargedBy` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: Currency` Terms currency. - `description: str` Plain-text fee disclosure. - `fee_type: FeeType` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: FeeFrequency` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: Optional[str]` Exact fixed amount, when amount-based. - `duration_years: Optional[str]` Charge duration in years, when specified. - `hurdle_rate: Optional[str]` Carry hurdle as a decimal fraction, when specified. - `rate: Optional[str]` Decimal fraction between zero and one, when percentage-based. - `funded_percent: Optional[str]` Percentage of dollar allocation funded, derived from the allocation pair. - `funding_deadline: Optional[datetime]` Funding deadline. - `manager_name: Optional[str]` SPV manager. - `minimum_investment_amount: Optional[str]` Minimum investment amount. - `opened_at: Optional[datetime]` Time the vehicle opened. - `price_per_share: Optional[str]` Price per share excluding fees. - `remaining_allocation_amount: Optional[str]` Remaining dollar allocation. - `remaining_share_allocation: Optional[str]` Remaining share allocation. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. - `total_allocation_amount: Optional[str]` Total dollar allocation. - `total_share_allocation: Optional[str]` Total share allocation. - `valuation: Optional[str]` Exact company valuation. - `valuation_basis: Optional[ValuationBasis]` Meaning of `valuation`. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Private Market Get Iois Response - `class PrivateMarketGetIoisResponse: …` - `data: IoiListingResourceList` - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Private Market Create Ioi Response - `class PrivateMarketCreateIoiResponse: …` - `data: IoiListingResource` IOI list item with the campaign identity needed to render it. - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Private Market Update Ioi Response - `class PrivateMarketUpdateIoiResponse: …` - `data: IoiListingResource` IOI list item with the campaign identity needed to render it. - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Private Market Get Company By ID Response - `class PrivateMarketGetCompanyByIDResponse: …` - `data: CompanyDetail` A company's identity and its complete published profile. - `id: str` Stable company identifier. - `name: str` Display name. - `profile: CompanyProfileResource` The complete versioned company profile. - `categories: Optional[List[CompanyCategory]]` Company categories. - `name: str` Display name. - `slug: str` Stable lowercase category slug. - `citations: Optional[List[CompanyCitation]]` Sources referenced by narrative sections and metrics. - `id: str` Stable profile-local citation identifier. - `source: str` Source publisher or provider. - `title: str` Human-readable source title. - `url: str` Source URL. - `published_at: Optional[datetime]` Source publication time, when known. - `customers: Optional[List[CompanyCustomer]]` Named customers evidenced by the source material. - `name: str` Customer name. - `logo_url: Optional[str]` Customer logo, when supplied. - `documents: Optional[List[CompanyDocumentResource]]` Company-level research and source documents. - `document_type: CompanyDocumentType` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: CompanyDocumentRelation` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: str` Display title. - `url: str` Document URL. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `preview: Optional[CompanyDocumentPreview]` Optional card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. - `published_at: Optional[datetime]` Publication time, when known. - `headquarters: Optional[CompanyHeadquarters]` Company headquarters, when known. - `city: str` City. - `country: str` Country. - `legal_entities: Optional[List[CompanyLegalEntity]]` Known legal entities associated with the company. - `country: str` Country name or ISO country code supplied by the source. - `name: str` Legal name. - `metric_series: Optional[List[CompanyMetricSeries]]` Historical and estimated metric series. - `frequency: MetricFrequency` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: str` Display label. - `metric_key: MetricKey` 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: str` Publisher/provider name. - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `points: Optional[List[CompanyMetricPoint]]` Ordered observations. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. - `source_url: Optional[str]` Source URL, when available. - `narrative_sections: Optional[List[CompanyNarrativeSection]]` Ordered durable company fact and thesis blocks. - `body: str` Plain-text section body. - `display_order: int` Stable display position within the profile. - `title: str` Section heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this block. - `overview: Optional[str]` Long company overview. - `people: Optional[List[CompanyPerson]]` Key people and their roles. - `name: str` Display name. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `roles: Optional[List[CompanyPersonRole]]` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: Optional[List[CompanySocialLink]]` Social/profile links. - `type: CompanySocialType` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: str` Link URL. - `tagline: Optional[str]` Short durable positioning line used with the company name. - `profile_schema_version: int` Profile schema version discriminator. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `published_at: Optional[datetime]` Publication time. # Companies ## Domain Types ### Company Category - `class CompanyCategory: …` A company category. - `name: str` Display name. - `slug: str` Stable lowercase category slug. ### Company Citation - `class CompanyCitation: …` A cited source. - `id: str` Stable profile-local citation identifier. - `source: str` Source publisher or provider. - `title: str` Human-readable source title. - `url: str` Source URL. - `published_at: Optional[datetime]` Source publication time, when known. ### Company Customer - `class CompanyCustomer: …` A named company customer. - `name: str` Customer name. - `logo_url: Optional[str]` Customer logo, when supplied. ### Company Detail - `class CompanyDetail: …` A company's identity and its complete published profile. - `id: str` Stable company identifier. - `name: str` Display name. - `profile: CompanyProfileResource` The complete versioned company profile. - `categories: Optional[List[CompanyCategory]]` Company categories. - `name: str` Display name. - `slug: str` Stable lowercase category slug. - `citations: Optional[List[CompanyCitation]]` Sources referenced by narrative sections and metrics. - `id: str` Stable profile-local citation identifier. - `source: str` Source publisher or provider. - `title: str` Human-readable source title. - `url: str` Source URL. - `published_at: Optional[datetime]` Source publication time, when known. - `customers: Optional[List[CompanyCustomer]]` Named customers evidenced by the source material. - `name: str` Customer name. - `logo_url: Optional[str]` Customer logo, when supplied. - `documents: Optional[List[CompanyDocumentResource]]` Company-level research and source documents. - `document_type: CompanyDocumentType` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: CompanyDocumentRelation` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: str` Display title. - `url: str` Document URL. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `preview: Optional[CompanyDocumentPreview]` Optional card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. - `published_at: Optional[datetime]` Publication time, when known. - `headquarters: Optional[CompanyHeadquarters]` Company headquarters, when known. - `city: str` City. - `country: str` Country. - `legal_entities: Optional[List[CompanyLegalEntity]]` Known legal entities associated with the company. - `country: str` Country name or ISO country code supplied by the source. - `name: str` Legal name. - `metric_series: Optional[List[CompanyMetricSeries]]` Historical and estimated metric series. - `frequency: MetricFrequency` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: str` Display label. - `metric_key: MetricKey` 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: str` Publisher/provider name. - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `points: Optional[List[CompanyMetricPoint]]` Ordered observations. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. - `source_url: Optional[str]` Source URL, when available. - `narrative_sections: Optional[List[CompanyNarrativeSection]]` Ordered durable company fact and thesis blocks. - `body: str` Plain-text section body. - `display_order: int` Stable display position within the profile. - `title: str` Section heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this block. - `overview: Optional[str]` Long company overview. - `people: Optional[List[CompanyPerson]]` Key people and their roles. - `name: str` Display name. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `roles: Optional[List[CompanyPersonRole]]` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: Optional[List[CompanySocialLink]]` Social/profile links. - `type: CompanySocialType` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: str` Link URL. - `tagline: Optional[str]` Short durable positioning line used with the company name. - `profile_schema_version: int` Profile schema version discriminator. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `published_at: Optional[datetime]` Publication time. ### Company Document Preview - `class CompanyDocumentPreview: …` Optional document card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. ### Company Document Relation - `Literal["SUBJECT", "CONNECTED"]` How a document relates to the company. - `"SUBJECT"` - `"CONNECTED"` ### Company Document Resource - `class CompanyDocumentResource: …` A company-level research or source document. - `document_type: CompanyDocumentType` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: CompanyDocumentRelation` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: str` Display title. - `url: str` Document URL. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `preview: Optional[CompanyDocumentPreview]` Optional card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. - `published_at: Optional[datetime]` Publication time, when known. ### Company Document Type - `Literal["COMPANY_PROFILE", "MARKET_RESEARCH", "INTERVIEW", 4 more]` Company document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` ### Company Headquarters - `class CompanyHeadquarters: …` Company headquarters. - `city: str` City. - `country: str` Country. ### Company Legal Entity - `class CompanyLegalEntity: …` A legal entity associated with the company. - `country: str` Country name or ISO country code supplied by the source. - `name: str` Legal name. ### Company Metric Point - `class CompanyMetricPoint: …` One metric observation. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. ### Company Metric Series - `class CompanyMetricSeries: …` A historical or estimated company metric series. - `frequency: MetricFrequency` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: str` Display label. - `metric_key: MetricKey` 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: str` Publisher/provider name. - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `points: Optional[List[CompanyMetricPoint]]` Ordered observations. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. - `source_url: Optional[str]` Source URL, when available. ### Company Narrative Section - `class CompanyNarrativeSection: …` One ordered durable narrative block. - `body: str` Plain-text section body. - `display_order: int` Stable display position within the profile. - `title: str` Section heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this block. ### Company Person - `class CompanyPerson: …` A key person associated with the company. - `name: str` Display name. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `roles: Optional[List[CompanyPersonRole]]` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` ### Company Person Role - `Literal["FOUNDER", "CEO", "OTHER"]` A key person's relationship to the company. - `"FOUNDER"` - `"CEO"` - `"OTHER"` ### Company Profile Resource - `class CompanyProfileResource: …` The complete versioned company profile (schema version one). - `categories: Optional[List[CompanyCategory]]` Company categories. - `name: str` Display name. - `slug: str` Stable lowercase category slug. - `citations: Optional[List[CompanyCitation]]` Sources referenced by narrative sections and metrics. - `id: str` Stable profile-local citation identifier. - `source: str` Source publisher or provider. - `title: str` Human-readable source title. - `url: str` Source URL. - `published_at: Optional[datetime]` Source publication time, when known. - `customers: Optional[List[CompanyCustomer]]` Named customers evidenced by the source material. - `name: str` Customer name. - `logo_url: Optional[str]` Customer logo, when supplied. - `documents: Optional[List[CompanyDocumentResource]]` Company-level research and source documents. - `document_type: CompanyDocumentType` Typed document kind. - `"COMPANY_PROFILE"` - `"MARKET_RESEARCH"` - `"INTERVIEW"` - `"DEAL_SHEET"` - `"PRESS_RELEASE"` - `"NEWS"` - `"OTHER"` - `relation: CompanyDocumentRelation` Relationship to this company. - `"SUBJECT"` - `"CONNECTED"` - `title: str` Display title. - `url: str` Document URL. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `preview: Optional[CompanyDocumentPreview]` Optional card preview. - `description: Optional[str]` Preview description. - `image_url: Optional[str]` Preview image URL. - `published_at: Optional[datetime]` Publication time, when known. - `headquarters: Optional[CompanyHeadquarters]` Company headquarters, when known. - `city: str` City. - `country: str` Country. - `legal_entities: Optional[List[CompanyLegalEntity]]` Known legal entities associated with the company. - `country: str` Country name or ISO country code supplied by the source. - `name: str` Legal name. - `metric_series: Optional[List[CompanyMetricSeries]]` Historical and estimated metric series. - `frequency: MetricFrequency` Observation cadence. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` - `label: str` Display label. - `metric_key: MetricKey` 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: str` Publisher/provider name. - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `points: Optional[List[CompanyMetricPoint]]` Ordered observations. - `observed_at: datetime` Observation time. - `value: str` Exact decimal value, serialized as a string. - `value_type: MetricValueType` Historical or estimated classification. - `"HISTORICAL"` - `"ESTIMATED"` - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this point. - `source_event_id: Optional[str]` Optional source event identifier. - `source_metadata: Optional[Dict[str, str]]` Optional provider reconciliation metadata. - `source_url: Optional[str]` Source URL, when available. - `narrative_sections: Optional[List[CompanyNarrativeSection]]` Ordered durable company fact and thesis blocks. - `body: str` Plain-text section body. - `display_order: int` Stable display position within the profile. - `title: str` Section heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting this block. - `overview: Optional[str]` Long company overview. - `people: Optional[List[CompanyPerson]]` Key people and their roles. - `name: str` Display name. - `external_id: Optional[str]` Optional source identifier retained for reconciliation. - `roles: Optional[List[CompanyPersonRole]]` One or more curated company roles. - `"FOUNDER"` - `"CEO"` - `"OTHER"` - `social: Optional[List[CompanySocialLink]]` Social/profile links. - `type: CompanySocialType` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: str` Link URL. - `tagline: Optional[str]` Short durable positioning line used with the company name. ### Company Social Link - `class CompanySocialLink: …` A company social/profile link. - `type: CompanySocialType` Link type. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` - `url: str` Link URL. ### Company Social Type - `Literal["WEBSITE", "LINKEDIN", "X", 2 more]` Kind of company social/profile link. - `"WEBSITE"` - `"LINKEDIN"` - `"X"` - `"FACEBOOK"` - `"OTHER"` ### Metric Frequency - `Literal["YEAR", "QUARTER", "MONTH", "POINT_IN_TIME"]` Observation cadence for a metric series. - `"YEAR"` - `"QUARTER"` - `"MONTH"` - `"POINT_IN_TIME"` ### Metric Key - `Literal["ANNUALIZED_REVENUE", "REVENUE_GROWTH", "VALUATION", 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 - `class IoiCompanyResource: …` Company identity embedded in an IOI list item. - `id: str` - `name: str` ### Ioi Listing Resource - `class IoiListingResource: …` IOI list item with the campaign identity needed to render it. - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Ioi Listing Resource List - `List[IoiListingResource]` - `company: IoiCompanyResource` Company identity embedded in an IOI list item. - `id: str` - `name: str` - `offering: IoiOfferingResource` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Ioi Offering Resource - `class IoiOfferingResource: …` Offering identity embedded in an IOI list item. - `id: str` - `headline: str` ### Ioi Resource - `class IoiResource: …` One live indication of interest. - `id: str` - `account_id: int` - `created_at: datetime` - `currency: Currency` Terms currency. - `"USD"` - `notional_amount: str` - `offering_id: str` - `updated_at: datetime` - `nda_acceptance: Optional[NdaAcceptanceResource]` Most recent NDA acceptance linked to this IOI, if any. - `accepted_at: datetime` - `agreement_id: str` - `version: int` ### Nda Acceptance Resource - `class NdaAcceptanceResource: …` 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: datetime` - `agreement_id: str` - `version: int` # Offerings ## List Offerings `v1.private_markets.offerings.get_offerings(OfferingGetOfferingsParams**kwargs) -> OfferingGetOfferingsResponse` **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: int` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `class OfferingGetOfferingsResponse: …` - `data: OfferingCardList` - `id: str` Stable public identifier; IOIs and history hang off it. - `class_: OfferingClass` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: OfferingCompany` Owning company identity. - `id: str` Stable company identifier. - `name: str` Display name. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `currency: Currency` Terms currency. - `"USD"` - `headline: str` Card/detail headline. - `summary: str` Top opportunity paragraph. - `indicative_price_high: Optional[str]` Indicative price-per-share range, high endpoint. - `indicative_price_low: Optional[str]` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: Optional[ValuationBasis]` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: Optional[str]` Indicative valuation range, high endpoint. - `indicative_valuation_low: Optional[str]` Indicative valuation range, low endpoint. - `ioi_deadline: Optional[datetime]` Deadline for indications of interest. - `minimum_ioi_amount: Optional[str]` Minimum indication-of-interest amount. - `spv: Optional[OfferingSpv]` Attached SPV identity and lifecycle, once one exists. - `id: str` Stable SPV identifier. - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: Optional[str]` Custodian. - `manager_name: Optional[str]` SPV manager. - `nda_agreement: Optional[NdaAgreementResource]` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.offerings.get_offerings( account_id=0, ) print(response) ``` #### 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 `v1.private_markets.offerings.get_offering_by_id(stroffering_id, OfferingGetOfferingByIDParams**kwargs) -> OfferingGetOfferingByIDResponse` **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: str` - `account_id: int` Account whose account-holder entity must hold an accreditation attestation to browse private-market offerings. ### Returns - `class OfferingGetOfferingByIDResponse: …` - `data: OfferingDetail` One offering with everything needed to render its detail payload. - `disclosures: Optional[str]` Important disclosures. - `documents: Optional[List[OfferingDocumentResource]]` Campaign documents in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `document_type: OfferingDocumentType` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: str` Display title. - `object_key: Optional[str]` Object-store key, when the document is stored internally. - `published_at: Optional[datetime]` Publication time, when known. - `source: Optional[str]` Source publisher/provider. - `source_url: Optional[str]` Source URL. - `url: Optional[str]` Externally reachable URL, when the document lives at one. - `highlights: Optional[List[OfferingHighlight]]` Ordered resolved highlights. - `label: str` Display label (the highlight's override, else the series' own label). - `metric_key: str` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: Optional[datetime]` Observation time of the latest value. - `value: Optional[str]` Latest observed value, when the series carries any points. - `value_type: Optional[MetricValueType]` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` - `investment_thesis: Optional[str]` Campaign-specific investment framing. - `key_risks: Optional[List[OfferingKeyRisk]]` Ordered key risks. - `body: str` Plain-text risk body. - `title: str` Risk heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting the risk. - `participants: Optional[List[OfferingParticipantResource]]` Campaign participants in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `name: str` Display name. - `role: ParticipantRole` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` - `structure_description: Optional[str]` Vehicle/structure framing shown before typed SPV terms exist. - `why_now: Optional[str]` Why-now framing. ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.private_markets.offerings.get_offering_by_id( offering_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id=0, ) print(response) ``` #### 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 - `Literal["USD"]` Terms currency. - `"USD"` ### Metric Unit - `Literal["USD", "PERCENT", "COUNT", "RANK"]` Unit for a resolved highlight metric. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` ### Metric Value Type - `Literal["HISTORICAL", "ESTIMATED"]` Whether a resolved highlight value is observed or estimated. - `"HISTORICAL"` - `"ESTIMATED"` ### Nda Agreement Resource - `class NdaAgreementResource: …` Current NDA agreement for an SPV-backed deal. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. ### Offering Card - `class OfferingCard: …` One offering as it appears in a list: its derived class, indicative terms, a company identity summary, and any attached SPV. - `id: str` Stable public identifier; IOIs and history hang off it. - `class_: OfferingClass` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: OfferingCompany` Owning company identity. - `id: str` Stable company identifier. - `name: str` Display name. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `currency: Currency` Terms currency. - `"USD"` - `headline: str` Card/detail headline. - `summary: str` Top opportunity paragraph. - `indicative_price_high: Optional[str]` Indicative price-per-share range, high endpoint. - `indicative_price_low: Optional[str]` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: Optional[ValuationBasis]` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: Optional[str]` Indicative valuation range, high endpoint. - `indicative_valuation_low: Optional[str]` Indicative valuation range, low endpoint. - `ioi_deadline: Optional[datetime]` Deadline for indications of interest. - `minimum_ioi_amount: Optional[str]` Minimum indication-of-interest amount. - `spv: Optional[OfferingSpv]` Attached SPV identity and lifecycle, once one exists. - `id: str` Stable SPV identifier. - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: Optional[str]` Custodian. - `manager_name: Optional[str]` SPV manager. - `nda_agreement: Optional[NdaAgreementResource]` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. ### Offering Card List - `List[OfferingCard]` - `id: str` Stable public identifier; IOIs and history hang off it. - `class_: OfferingClass` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: OfferingCompany` Owning company identity. - `id: str` Stable company identifier. - `name: str` Display name. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `currency: Currency` Terms currency. - `"USD"` - `headline: str` Card/detail headline. - `summary: str` Top opportunity paragraph. - `indicative_price_high: Optional[str]` Indicative price-per-share range, high endpoint. - `indicative_price_low: Optional[str]` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: Optional[ValuationBasis]` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: Optional[str]` Indicative valuation range, high endpoint. - `indicative_valuation_low: Optional[str]` Indicative valuation range, low endpoint. - `ioi_deadline: Optional[datetime]` Deadline for indications of interest. - `minimum_ioi_amount: Optional[str]` Minimum indication-of-interest amount. - `spv: Optional[OfferingSpv]` Attached SPV identity and lifecycle, once one exists. - `id: str` Stable SPV identifier. - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: Optional[str]` Custodian. - `manager_name: Optional[str]` SPV manager. - `nda_agreement: Optional[NdaAgreementResource]` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. ### Offering Class - `Literal["UPCOMING", "ACTIVE"]` Derived offering classification. - `"UPCOMING"` - `"ACTIVE"` ### Offering Company - `class OfferingCompany: …` Company identity carried on an offering card/detail. - `id: str` Stable company identifier. - `name: str` Display name. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. ### Offering Detail - `class OfferingDetail: …` One offering with everything needed to render its detail payload. - `disclosures: Optional[str]` Important disclosures. - `documents: Optional[List[OfferingDocumentResource]]` Campaign documents in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `document_type: OfferingDocumentType` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: str` Display title. - `object_key: Optional[str]` Object-store key, when the document is stored internally. - `published_at: Optional[datetime]` Publication time, when known. - `source: Optional[str]` Source publisher/provider. - `source_url: Optional[str]` Source URL. - `url: Optional[str]` Externally reachable URL, when the document lives at one. - `highlights: Optional[List[OfferingHighlight]]` Ordered resolved highlights. - `label: str` Display label (the highlight's override, else the series' own label). - `metric_key: str` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: Optional[datetime]` Observation time of the latest value. - `value: Optional[str]` Latest observed value, when the series carries any points. - `value_type: Optional[MetricValueType]` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` - `investment_thesis: Optional[str]` Campaign-specific investment framing. - `key_risks: Optional[List[OfferingKeyRisk]]` Ordered key risks. - `body: str` Plain-text risk body. - `title: str` Risk heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting the risk. - `participants: Optional[List[OfferingParticipantResource]]` Campaign participants in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `name: str` Display name. - `role: ParticipantRole` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` - `structure_description: Optional[str]` Vehicle/structure framing shown before typed SPV terms exist. - `why_now: Optional[str]` Why-now framing. ### Offering Document Resource - `class OfferingDocumentResource: …` A campaign document's display metadata. Exactly one of `url`/`object_key` is set; an object key is resolved and signed elsewhere. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `document_type: OfferingDocumentType` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: str` Display title. - `object_key: Optional[str]` Object-store key, when the document is stored internally. - `published_at: Optional[datetime]` Publication time, when known. - `source: Optional[str]` Source publisher/provider. - `source_url: Optional[str]` Source URL. - `url: Optional[str]` Externally reachable URL, when the document lives at one. ### Offering Document Type - `Literal["TEARSHEET", "KEY_TERMS", "RISK_FACTORS", 2 more]` Kind of campaign document. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` ### Offering Highlight - `class OfferingHighlight: …` A curated highlight, resolved against the company profile's metric series. - `label: str` Display label (the highlight's override, else the series' own label). - `metric_key: str` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: Optional[datetime]` Observation time of the latest value. - `value: Optional[str]` Latest observed value, when the series carries any points. - `value_type: Optional[MetricValueType]` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` ### Offering Key Risk - `class OfferingKeyRisk: …` One ordered key-risk block. - `body: str` Plain-text risk body. - `title: str` Risk heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting the risk. ### Offering Participant Resource - `class OfferingParticipantResource: …` An offering participant's display data. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `name: str` Display name. - `role: ParticipantRole` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` ### Offering Spv - `class OfferingSpv: …` 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: str` Stable SPV identifier. - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: Optional[str]` Custodian. - `manager_name: Optional[str]` SPV manager. - `nda_agreement: Optional[NdaAgreementResource]` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. ### Participant Role - `Literal["LEAD_INVESTOR", "CO_LEAD", "FUND_MANAGER", "PLACEMENT_AGENT"]` Presentation role of an offering participant. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` ### Spv Status - `Literal["DRAFT", "OPEN", "CLOSED", 2 more]` SPV lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` ### Valuation Basis - `Literal["PRE_MONEY", "POST_MONEY", "REFERENCE", "IMPLIED"]` Meaning of an indicative valuation range or an SPV valuation. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Offering Get Offerings Response - `class OfferingGetOfferingsResponse: …` - `data: OfferingCardList` - `id: str` Stable public identifier; IOIs and history hang off it. - `class_: OfferingClass` Derived classification. - `"UPCOMING"` - `"ACTIVE"` - `company: OfferingCompany` Owning company identity. - `id: str` Stable company identifier. - `name: str` Display name. - `short_description: str` Short card/search description. - `slug: str` Lowercase URL slug. - `logo_url: Optional[str]` Company logo URL, when known. - `primary_domain: Optional[str]` Canonical lowercase domain, when known. - `currency: Currency` Terms currency. - `"USD"` - `headline: str` Card/detail headline. - `summary: str` Top opportunity paragraph. - `indicative_price_high: Optional[str]` Indicative price-per-share range, high endpoint. - `indicative_price_low: Optional[str]` Indicative price-per-share range, low endpoint. - `indicative_valuation_basis: Optional[ValuationBasis]` Meaning of the indicative valuation range. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` - `indicative_valuation_high: Optional[str]` Indicative valuation range, high endpoint. - `indicative_valuation_low: Optional[str]` Indicative valuation range, low endpoint. - `ioi_deadline: Optional[datetime]` Deadline for indications of interest. - `minimum_ioi_amount: Optional[str]` Minimum indication-of-interest amount. - `spv: Optional[OfferingSpv]` Attached SPV identity and lifecycle, once one exists. - `id: str` Stable SPV identifier. - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `custodian_name: Optional[str]` Custodian. - `manager_name: Optional[str]` SPV manager. - `nda_agreement: Optional[NdaAgreementResource]` Current NDA agreement. Absent when this SPV does not require one. - `acceptance_text: str` Exact assent and authority representation shown to the signer. - `acceptance_text_version: int` Version of the acceptance representation. - `agreement_id: str` Stable agreement identifier submitted with an IOI acceptance. - `document_reference: str` Durable reference to the immutable NDA artifact. - `document_sha256: str` Lowercase SHA-256 digest of the artifact bytes. - `effective_at: datetime` Time this version became effective. - `version: int` Strictly increasing SPV-local agreement version. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. ### Offering Get Offering By ID Response - `class OfferingGetOfferingByIDResponse: …` - `data: OfferingDetail` One offering with everything needed to render its detail payload. - `disclosures: Optional[str]` Important disclosures. - `documents: Optional[List[OfferingDocumentResource]]` Campaign documents in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `document_type: OfferingDocumentType` Document kind. - `"TEARSHEET"` - `"KEY_TERMS"` - `"RISK_FACTORS"` - `"PPM"` - `"OTHER"` - `title: str` Display title. - `object_key: Optional[str]` Object-store key, when the document is stored internally. - `published_at: Optional[datetime]` Publication time, when known. - `source: Optional[str]` Source publisher/provider. - `source_url: Optional[str]` Source URL. - `url: Optional[str]` Externally reachable URL, when the document lives at one. - `highlights: Optional[List[OfferingHighlight]]` Ordered resolved highlights. - `label: str` Display label (the highlight's override, else the series' own label). - `metric_key: str` Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`). - `unit: MetricUnit` Value unit. - `"USD"` - `"PERCENT"` - `"COUNT"` - `"RANK"` - `observed_at: Optional[datetime]` Observation time of the latest value. - `value: Optional[str]` Latest observed value, when the series carries any points. - `value_type: Optional[MetricValueType]` Whether the latest value is historical or estimated. - `"HISTORICAL"` - `"ESTIMATED"` - `investment_thesis: Optional[str]` Campaign-specific investment framing. - `key_risks: Optional[List[OfferingKeyRisk]]` Ordered key risks. - `body: str` Plain-text risk body. - `title: str` Risk heading. - `citation_ids: Optional[List[str]]` Profile-local citation ids supporting the risk. - `participants: Optional[List[OfferingParticipantResource]]` Campaign participants in display order. - `id: str` Stable identifier. - `display_order: int` Stable display position. - `name: str` Display name. - `role: ParticipantRole` Presentation role. - `"LEAD_INVESTOR"` - `"CO_LEAD"` - `"FUND_MANAGER"` - `"PLACEMENT_AGENT"` - `structure_description: Optional[str]` Vehicle/structure framing shown before typed SPV terms exist. - `why_now: Optional[str]` Why-now framing. # Spvs ## Domain Types ### Charged By - `Literal["FUND_MANAGER", "CLEAR_STREET", "THIRD_PARTY"]` Party charging a fee. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` ### Fee Frequency - `Literal["ONE_TIME", "ANNUAL", "AT_EXIT", "PASS_THROUGH"]` Fee timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` ### Fee Type - `Literal["MANAGEMENT", "CARRY", "PLACEMENT", 2 more]` Kind of SPV fee. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` ### Spv Detail - `class SpvDetail: …` An OPEN SPV's identity, exact economics, and typed fee schedule. - `id: str` Stable SPV identifier. - `company_id: str` Company whose shares the vehicle holds. - `currency: Currency` Terms currency. - `"USD"` - `name: str` Legal/display name. - `status: SpvStatus` Lifecycle state. - `"DRAFT"` - `"OPEN"` - `"CLOSED"` - `"LIQUIDATING"` - `"DISSOLVED"` - `all_in_price_per_share: Optional[str]` Price per share including fees. - `custodian_name: Optional[str]` Custodian. - `fee_per_share: Optional[str]` Per-share fee. - `fee_terms: Optional[List[SpvFeeTermResource]]` Typed fee schedule. - `charged_by: ChargedBy` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: Currency` Terms currency. - `description: str` Plain-text fee disclosure. - `fee_type: FeeType` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: FeeFrequency` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: Optional[str]` Exact fixed amount, when amount-based. - `duration_years: Optional[str]` Charge duration in years, when specified. - `hurdle_rate: Optional[str]` Carry hurdle as a decimal fraction, when specified. - `rate: Optional[str]` Decimal fraction between zero and one, when percentage-based. - `funded_percent: Optional[str]` Percentage of dollar allocation funded, derived from the allocation pair. - `funding_deadline: Optional[datetime]` Funding deadline. - `manager_name: Optional[str]` SPV manager. - `minimum_investment_amount: Optional[str]` Minimum investment amount. - `opened_at: Optional[datetime]` Time the vehicle opened. - `price_per_share: Optional[str]` Price per share excluding fees. - `remaining_allocation_amount: Optional[str]` Remaining dollar allocation. - `remaining_share_allocation: Optional[str]` Remaining share allocation. - `share_class: Optional[str]` Underlying share class, when specified. - `structure_description: Optional[str]` Plain-text vehicle structure. - `total_allocation_amount: Optional[str]` Total dollar allocation. - `total_share_allocation: Optional[str]` Total share allocation. - `valuation: Optional[str]` Exact company valuation. - `valuation_basis: Optional[ValuationBasis]` Meaning of `valuation`. - `"PRE_MONEY"` - `"POST_MONEY"` - `"REFERENCE"` - `"IMPLIED"` ### Spv Fee Term Resource - `class SpvFeeTermResource: …` One typed SPV fee term. - `charged_by: ChargedBy` Charging party. - `"FUND_MANAGER"` - `"CLEAR_STREET"` - `"THIRD_PARTY"` - `currency: Currency` Terms currency. - `"USD"` - `description: str` Plain-text fee disclosure. - `fee_type: FeeType` Fee kind. - `"MANAGEMENT"` - `"CARRY"` - `"PLACEMENT"` - `"ADMINISTRATIVE"` - `"OTHER"` - `frequency: FeeFrequency` Timing/cadence. - `"ONE_TIME"` - `"ANNUAL"` - `"AT_EXIT"` - `"PASS_THROUGH"` - `amount: Optional[str]` Exact fixed amount, when amount-based. - `duration_years: Optional[str]` Charge duration in years, when specified. - `hurdle_rate: Optional[str]` Carry hurdle as a decimal fraction, when specified. - `rate: Optional[str]` Decimal fraction between zero and one, when percentage-based.