# Private Markets

## Get SPV

`PrivateMarketGetSpvByIdResponse v1().privateMarkets().getSpvById(PrivateMarketGetSpvByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**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

- `PrivateMarketGetSpvByIdParams params`

  - `Optional<String> spvId`

  - `long accountId`

    Account whose account-holder entity must hold an accreditation
    attestation to browse private-market offerings.

### Returns

- `class PrivateMarketGetSpvByIdResponse:`

  - `SpvDetail data`

    An OPEN SPV's identity, exact economics, and typed fee schedule.

    - `String id`

      Stable SPV identifier.

    - `String companyId`

      Company whose shares the vehicle holds.

    - `Currency currency`

      Terms currency.

      - `USD("USD")`

    - `String name`

      Legal/display name.

    - `SpvStatus status`

      Lifecycle state.

      - `DRAFT("DRAFT")`

      - `OPEN("OPEN")`

      - `CLOSED("CLOSED")`

      - `LIQUIDATING("LIQUIDATING")`

      - `DISSOLVED("DISSOLVED")`

    - `Optional<String> allInPricePerShare`

      Price per share including fees.

    - `Optional<String> custodianName`

      Custodian.

    - `Optional<String> feePerShare`

      Per-share fee.

    - `Optional<List<SpvFeeTermResource>> feeTerms`

      Typed fee schedule.

      - `ChargedBy chargedBy`

        Charging party.

        - `FUND_MANAGER("FUND_MANAGER")`

        - `CLEAR_STREET("CLEAR_STREET")`

        - `THIRD_PARTY("THIRD_PARTY")`

      - `Currency currency`

        Terms currency.

      - `String description`

        Plain-text fee disclosure.

      - `FeeType feeType`

        Fee kind.

        - `MANAGEMENT("MANAGEMENT")`

        - `CARRY("CARRY")`

        - `PLACEMENT("PLACEMENT")`

        - `ADMINISTRATIVE("ADMINISTRATIVE")`

        - `OTHER("OTHER")`

      - `FeeFrequency frequency`

        Timing/cadence.

        - `ONE_TIME("ONE_TIME")`

        - `ANNUAL("ANNUAL")`

        - `AT_EXIT("AT_EXIT")`

        - `PASS_THROUGH("PASS_THROUGH")`

      - `Optional<String> amount`

        Exact fixed amount, when amount-based.

      - `Optional<String> durationYears`

        Charge duration in years, when specified.

      - `Optional<String> hurdleRate`

        Carry hurdle as a decimal fraction, when specified.

      - `Optional<String> rate`

        Decimal fraction between zero and one, when percentage-based.

    - `Optional<String> fundedPercent`

      Percentage of dollar allocation funded, derived from the allocation pair.

    - `Optional<LocalDateTime> fundingDeadline`

      Funding deadline.

    - `Optional<String> managerName`

      SPV manager.

    - `Optional<String> minimumInvestmentAmount`

      Minimum investment amount.

    - `Optional<LocalDateTime> openedAt`

      Time the vehicle opened.

    - `Optional<String> pricePerShare`

      Price per share excluding fees.

    - `Optional<String> remainingAllocationAmount`

      Remaining dollar allocation.

    - `Optional<String> remainingShareAllocation`

      Remaining share allocation.

    - `Optional<String> shareClass`

      Underlying share class, when specified.

    - `Optional<String> structureDescription`

      Plain-text vehicle structure.

    - `Optional<String> totalAllocationAmount`

      Total dollar allocation.

    - `Optional<String> totalShareAllocation`

      Total share allocation.

    - `Optional<String> valuation`

      Exact company valuation.

    - `Optional<ValuationBasis> valuationBasis`

      Meaning of `valuation`.

      - `PRE_MONEY("PRE_MONEY")`

      - `POST_MONEY("POST_MONEY")`

      - `REFERENCE("REFERENCE")`

      - `IMPLIED("IMPLIED")`

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetSpvByIdParams;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetSpvByIdResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketGetSpvByIdParams params = PrivateMarketGetSpvByIdParams.builder()
            .spvId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .accountId(0L)
            .build();
        PrivateMarketGetSpvByIdResponse response = client.v1().privateMarkets().getSpvById(params);
    }
}
```

#### 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.

`PrivateMarketGetIoisResponse v1().privateMarkets().getIois(PrivateMarketGetIoisParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v1/private-markets/iois`

List every live IOI for the caller's account-holder entity.

### Parameters

- `PrivateMarketGetIoisParams params`

  - `long accountId`

### Returns

- `class PrivateMarketGetIoisResponse:`

  - `List<IoiListingResource> data`

    - `IoiCompanyResource company`

      Company identity embedded in an IOI list item.

      - `String id`

      - `String name`

    - `IoiOfferingResource offering`

      Offering identity embedded in an IOI list item.

      - `String id`

      - `String headline`

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetIoisParams;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetIoisResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketGetIoisParams params = PrivateMarketGetIoisParams.builder()
            .accountId(0L)
            .build();
        PrivateMarketGetIoisResponse response = client.v1().privateMarkets().getIois(params);
    }
}
```

#### 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.

`PrivateMarketCreateIoiResponse v1().privateMarkets().createIoi(PrivateMarketCreateIoiParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/private-markets/iois`

Create an IOI for a visible upcoming offering.

### Parameters

- `PrivateMarketCreateIoiParams params`

  - `long accountId`

  - `String notionalAmount`

  - `String offeringId`

  - `Optional<NdaAcceptance> ndaAcceptance`

    Required only when the offering's attached SPV has an NDA agreement.

    - `boolean accepted`

      Must be true; confirms affirmative assent.

    - `String agreementId`

      Exact agreement id returned by offering detail.

    - `boolean authorityConfirmed`

      Must be true; confirms the signer may bind the account-holder entity.

### Returns

- `class PrivateMarketCreateIoiResponse:`

  - `IoiListingResource data`

    IOI list item with the campaign identity needed to render it.

    - `IoiCompanyResource company`

      Company identity embedded in an IOI list item.

      - `String id`

      - `String name`

    - `IoiOfferingResource offering`

      Offering identity embedded in an IOI list item.

      - `String id`

      - `String headline`

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketCreateIoiParams;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketCreateIoiResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketCreateIoiParams params = PrivateMarketCreateIoiParams.builder()
            .accountId(0L)
            .notionalAmount("100000.00")
            .offeringId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .build();
        PrivateMarketCreateIoiResponse response = client.v1().privateMarkets().createIoi(params);
    }
}
```

#### 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.

`PrivateMarketUpdateIoiResponse v1().privateMarkets().updateIoi(PrivateMarketUpdateIoiParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**patch** `/v1/private-markets/iois/{ioi_id}`

Update an IOI's notional, accepting the current NDA revision when required.

### Parameters

- `PrivateMarketUpdateIoiParams params`

  - `Optional<String> ioiId`

  - `long accountId`

  - `String notionalAmount`

  - `Optional<NdaAcceptance> ndaAcceptance`

    Required when the SPV's current NDA version is newer than the IOI's
    latest acceptance. Irrelevant acceptances are rejected.

    - `boolean accepted`

      Must be true; confirms affirmative assent.

    - `String agreementId`

      Exact agreement id returned by offering detail.

    - `boolean authorityConfirmed`

      Must be true; confirms the signer may bind the account-holder entity.

### Returns

- `class PrivateMarketUpdateIoiResponse:`

  - `IoiListingResource data`

    IOI list item with the campaign identity needed to render it.

    - `IoiCompanyResource company`

      Company identity embedded in an IOI list item.

      - `String id`

      - `String name`

    - `IoiOfferingResource offering`

      Offering identity embedded in an IOI list item.

      - `String id`

      - `String headline`

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketUpdateIoiParams;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketUpdateIoiResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketUpdateIoiParams params = PrivateMarketUpdateIoiParams.builder()
            .ioiId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .accountId(0L)
            .notionalAmount("125000.00")
            .build();
        PrivateMarketUpdateIoiResponse response = client.v1().privateMarkets().updateIoi(params);
    }
}
```

#### 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().privateMarkets().deleteIoi(PrivateMarketDeleteIoiParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**delete** `/v1/private-markets/iois/{ioi_id}`

Withdraw a live IOI. Repeating a withdrawal returns 404.

### Parameters

- `PrivateMarketDeleteIoiParams params`

  - `Optional<String> ioiId`

  - `long accountId`

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketDeleteIoiParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketDeleteIoiParams params = PrivateMarketDeleteIoiParams.builder()
            .ioiId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .accountId(0L)
            .build();
        client.v1().privateMarkets().deleteIoi(params);
    }
}
```

## Get Company

`PrivateMarketGetCompanyByIdResponse v1().privateMarkets().getCompanyById(PrivateMarketGetCompanyByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**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

- `PrivateMarketGetCompanyByIdParams params`

  - `Optional<String> companyId`

  - `long accountId`

    Account whose account-holder entity must hold an accreditation
    attestation to browse private-market offerings.

### Returns

- `class PrivateMarketGetCompanyByIdResponse:`

  - `CompanyDetail data`

    A company's identity and its complete published profile.

    - `String id`

      Stable company identifier.

    - `String name`

      Display name.

    - `CompanyProfileResource profile`

      The complete versioned company profile.

      - `Optional<List<CompanyCategory>> categories`

        Company categories.

        - `String name`

          Display name.

        - `String slug`

          Stable lowercase category slug.

      - `Optional<List<CompanyCitation>> citations`

        Sources referenced by narrative sections and metrics.

        - `String id`

          Stable profile-local citation identifier.

        - `String source`

          Source publisher or provider.

        - `String title`

          Human-readable source title.

        - `String url`

          Source URL.

        - `Optional<LocalDateTime> publishedAt`

          Source publication time, when known.

      - `Optional<List<CompanyCustomer>> customers`

        Named customers evidenced by the source material.

        - `String name`

          Customer name.

        - `Optional<String> logoUrl`

          Customer logo, when supplied.

      - `Optional<List<CompanyDocumentResource>> documents`

        Company-level research and source documents.

        - `CompanyDocumentType documentType`

          Typed document kind.

          - `COMPANY_PROFILE("COMPANY_PROFILE")`

          - `MARKET_RESEARCH("MARKET_RESEARCH")`

          - `INTERVIEW("INTERVIEW")`

          - `DEAL_SHEET("DEAL_SHEET")`

          - `PRESS_RELEASE("PRESS_RELEASE")`

          - `NEWS("NEWS")`

          - `OTHER("OTHER")`

        - `CompanyDocumentRelation relation`

          Relationship to this company.

          - `SUBJECT("SUBJECT")`

          - `CONNECTED("CONNECTED")`

        - `String title`

          Display title.

        - `String url`

          Document URL.

        - `Optional<String> externalId`

          Optional source identifier retained for reconciliation.

        - `Optional<CompanyDocumentPreview> preview`

          Optional card preview.

          - `Optional<String> description`

            Preview description.

          - `Optional<String> imageUrl`

            Preview image URL.

        - `Optional<LocalDateTime> publishedAt`

          Publication time, when known.

      - `Optional<CompanyHeadquarters> headquarters`

        Company headquarters, when known.

        - `String city`

          City.

        - `String country`

          Country.

      - `Optional<List<CompanyLegalEntity>> legalEntities`

        Known legal entities associated with the company.

        - `String country`

          Country name or ISO country code supplied by the source.

        - `String name`

          Legal name.

      - `Optional<List<CompanyMetricSeries>> metricSeries`

        Historical and estimated metric series.

        - `MetricFrequency frequency`

          Observation cadence.

          - `YEAR("YEAR")`

          - `QUARTER("QUARTER")`

          - `MONTH("MONTH")`

          - `POINT_IN_TIME("POINT_IN_TIME")`

        - `String label`

          Display label.

        - `MetricKey metricKey`

          Canonical metric key.

          - `ANNUALIZED_REVENUE("ANNUALIZED_REVENUE")`

          - `REVENUE_GROWTH("REVENUE_GROWTH")`

          - `VALUATION("VALUATION")`

          - `ISSUE_PRICE("ISSUE_PRICE")`

          - `PRICE_PER_SHARE("PRICE_PER_SHARE")`

          - `AMOUNT_RAISED("AMOUNT_RAISED")`

          - `ORDER_VOLUME("ORDER_VOLUME")`

          - `PIPELINE_VALUE("PIPELINE_VALUE")`

          - `GROSS_MARGIN("GROSS_MARGIN")`

          - `EBIT_MARGIN("EBIT_MARGIN")`

          - `FCF_CONVERSION("FCF_CONVERSION")`

          - `CONTRACTED_REVENUE_PERCENT("CONTRACTED_REVENUE_PERCENT")`

          - `NET_REVENUE_RETENTION("NET_REVENUE_RETENTION")`

          - `CUSTOMER_COUNT("CUSTOMER_COUNT")`

          - `MARKET_POSITION("MARKET_POSITION")`

        - `String source`

          Publisher/provider name.

        - `MetricUnit unit`

          Value unit.

          - `USD("USD")`

          - `PERCENT("PERCENT")`

          - `COUNT("COUNT")`

          - `RANK("RANK")`

        - `Optional<String> externalId`

          Optional source identifier retained for reconciliation.

        - `Optional<List<CompanyMetricPoint>> points`

          Ordered observations.

          - `LocalDateTime observedAt`

            Observation time.

          - `String value`

            Exact decimal value, serialized as a string.

          - `MetricValueType valueType`

            Historical or estimated classification.

            - `HISTORICAL("HISTORICAL")`

            - `ESTIMATED("ESTIMATED")`

          - `Optional<List<String>> citationIds`

            Profile-local citation ids supporting this point.

          - `Optional<String> sourceEventId`

            Optional source event identifier.

          - `Optional<SourceMetadata> sourceMetadata`

            Optional provider reconciliation metadata.

        - `Optional<String> sourceUrl`

          Source URL, when available.

      - `Optional<List<CompanyNarrativeSection>> narrativeSections`

        Ordered durable company fact and thesis blocks.

        - `String body`

          Plain-text section body.

        - `long displayOrder`

          Stable display position within the profile.

        - `String title`

          Section heading.

        - `Optional<List<String>> citationIds`

          Profile-local citation ids supporting this block.

      - `Optional<String> overview`

        Long company overview.

      - `Optional<List<CompanyPerson>> people`

        Key people and their roles.

        - `String name`

          Display name.

        - `Optional<String> externalId`

          Optional source identifier retained for reconciliation.

        - `Optional<List<CompanyPersonRole>> roles`

          One or more curated company roles.

          - `FOUNDER("FOUNDER")`

          - `CEO("CEO")`

          - `OTHER("OTHER")`

      - `Optional<List<CompanySocialLink>> social`

        Social/profile links.

        - `CompanySocialType type`

          Link type.

          - `WEBSITE("WEBSITE")`

          - `LINKEDIN("LINKEDIN")`

          - `X("X")`

          - `FACEBOOK("FACEBOOK")`

          - `OTHER("OTHER")`

        - `String url`

          Link URL.

      - `Optional<String> tagline`

        Short durable positioning line used with the company name.

    - `long profileSchemaVersion`

      Profile schema version discriminator.

    - `String shortDescription`

      Short card/search description.

    - `String slug`

      Lowercase URL slug.

    - `Optional<String> logoUrl`

      Company logo URL, when known.

    - `Optional<String> primaryDomain`

      Canonical lowercase domain, when known.

    - `Optional<LocalDateTime> publishedAt`

      Publication time.

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetCompanyByIdParams;
import com.clearstreet.api.models.v1.privatemarkets.PrivateMarketGetCompanyByIdResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        PrivateMarketGetCompanyByIdParams params = PrivateMarketGetCompanyByIdParams.builder()
            .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .accountId(0L)
            .build();
        PrivateMarketGetCompanyByIdResponse response = client.v1().privateMarkets().getCompanyById(params);
    }
}
```

#### 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

- `class CompanyCategory:`

  A company category.

  - `String name`

    Display name.

  - `String slug`

    Stable lowercase category slug.

### Company Citation

- `class CompanyCitation:`

  A cited source.

  - `String id`

    Stable profile-local citation identifier.

  - `String source`

    Source publisher or provider.

  - `String title`

    Human-readable source title.

  - `String url`

    Source URL.

  - `Optional<LocalDateTime> publishedAt`

    Source publication time, when known.

### Company Customer

- `class CompanyCustomer:`

  A named company customer.

  - `String name`

    Customer name.

  - `Optional<String> logoUrl`

    Customer logo, when supplied.

### Company Detail

- `class CompanyDetail:`

  A company's identity and its complete published profile.

  - `String id`

    Stable company identifier.

  - `String name`

    Display name.

  - `CompanyProfileResource profile`

    The complete versioned company profile.

    - `Optional<List<CompanyCategory>> categories`

      Company categories.

      - `String name`

        Display name.

      - `String slug`

        Stable lowercase category slug.

    - `Optional<List<CompanyCitation>> citations`

      Sources referenced by narrative sections and metrics.

      - `String id`

        Stable profile-local citation identifier.

      - `String source`

        Source publisher or provider.

      - `String title`

        Human-readable source title.

      - `String url`

        Source URL.

      - `Optional<LocalDateTime> publishedAt`

        Source publication time, when known.

    - `Optional<List<CompanyCustomer>> customers`

      Named customers evidenced by the source material.

      - `String name`

        Customer name.

      - `Optional<String> logoUrl`

        Customer logo, when supplied.

    - `Optional<List<CompanyDocumentResource>> documents`

      Company-level research and source documents.

      - `CompanyDocumentType documentType`

        Typed document kind.

        - `COMPANY_PROFILE("COMPANY_PROFILE")`

        - `MARKET_RESEARCH("MARKET_RESEARCH")`

        - `INTERVIEW("INTERVIEW")`

        - `DEAL_SHEET("DEAL_SHEET")`

        - `PRESS_RELEASE("PRESS_RELEASE")`

        - `NEWS("NEWS")`

        - `OTHER("OTHER")`

      - `CompanyDocumentRelation relation`

        Relationship to this company.

        - `SUBJECT("SUBJECT")`

        - `CONNECTED("CONNECTED")`

      - `String title`

        Display title.

      - `String url`

        Document URL.

      - `Optional<String> externalId`

        Optional source identifier retained for reconciliation.

      - `Optional<CompanyDocumentPreview> preview`

        Optional card preview.

        - `Optional<String> description`

          Preview description.

        - `Optional<String> imageUrl`

          Preview image URL.

      - `Optional<LocalDateTime> publishedAt`

        Publication time, when known.

    - `Optional<CompanyHeadquarters> headquarters`

      Company headquarters, when known.

      - `String city`

        City.

      - `String country`

        Country.

    - `Optional<List<CompanyLegalEntity>> legalEntities`

      Known legal entities associated with the company.

      - `String country`

        Country name or ISO country code supplied by the source.

      - `String name`

        Legal name.

    - `Optional<List<CompanyMetricSeries>> metricSeries`

      Historical and estimated metric series.

      - `MetricFrequency frequency`

        Observation cadence.

        - `YEAR("YEAR")`

        - `QUARTER("QUARTER")`

        - `MONTH("MONTH")`

        - `POINT_IN_TIME("POINT_IN_TIME")`

      - `String label`

        Display label.

      - `MetricKey metricKey`

        Canonical metric key.

        - `ANNUALIZED_REVENUE("ANNUALIZED_REVENUE")`

        - `REVENUE_GROWTH("REVENUE_GROWTH")`

        - `VALUATION("VALUATION")`

        - `ISSUE_PRICE("ISSUE_PRICE")`

        - `PRICE_PER_SHARE("PRICE_PER_SHARE")`

        - `AMOUNT_RAISED("AMOUNT_RAISED")`

        - `ORDER_VOLUME("ORDER_VOLUME")`

        - `PIPELINE_VALUE("PIPELINE_VALUE")`

        - `GROSS_MARGIN("GROSS_MARGIN")`

        - `EBIT_MARGIN("EBIT_MARGIN")`

        - `FCF_CONVERSION("FCF_CONVERSION")`

        - `CONTRACTED_REVENUE_PERCENT("CONTRACTED_REVENUE_PERCENT")`

        - `NET_REVENUE_RETENTION("NET_REVENUE_RETENTION")`

        - `CUSTOMER_COUNT("CUSTOMER_COUNT")`

        - `MARKET_POSITION("MARKET_POSITION")`

      - `String source`

        Publisher/provider name.

      - `MetricUnit unit`

        Value unit.

        - `USD("USD")`

        - `PERCENT("PERCENT")`

        - `COUNT("COUNT")`

        - `RANK("RANK")`

      - `Optional<String> externalId`

        Optional source identifier retained for reconciliation.

      - `Optional<List<CompanyMetricPoint>> points`

        Ordered observations.

        - `LocalDateTime observedAt`

          Observation time.

        - `String value`

          Exact decimal value, serialized as a string.

        - `MetricValueType valueType`

          Historical or estimated classification.

          - `HISTORICAL("HISTORICAL")`

          - `ESTIMATED("ESTIMATED")`

        - `Optional<List<String>> citationIds`

          Profile-local citation ids supporting this point.

        - `Optional<String> sourceEventId`

          Optional source event identifier.

        - `Optional<SourceMetadata> sourceMetadata`

          Optional provider reconciliation metadata.

      - `Optional<String> sourceUrl`

        Source URL, when available.

    - `Optional<List<CompanyNarrativeSection>> narrativeSections`

      Ordered durable company fact and thesis blocks.

      - `String body`

        Plain-text section body.

      - `long displayOrder`

        Stable display position within the profile.

      - `String title`

        Section heading.

      - `Optional<List<String>> citationIds`

        Profile-local citation ids supporting this block.

    - `Optional<String> overview`

      Long company overview.

    - `Optional<List<CompanyPerson>> people`

      Key people and their roles.

      - `String name`

        Display name.

      - `Optional<String> externalId`

        Optional source identifier retained for reconciliation.

      - `Optional<List<CompanyPersonRole>> roles`

        One or more curated company roles.

        - `FOUNDER("FOUNDER")`

        - `CEO("CEO")`

        - `OTHER("OTHER")`

    - `Optional<List<CompanySocialLink>> social`

      Social/profile links.

      - `CompanySocialType type`

        Link type.

        - `WEBSITE("WEBSITE")`

        - `LINKEDIN("LINKEDIN")`

        - `X("X")`

        - `FACEBOOK("FACEBOOK")`

        - `OTHER("OTHER")`

      - `String url`

        Link URL.

    - `Optional<String> tagline`

      Short durable positioning line used with the company name.

  - `long profileSchemaVersion`

    Profile schema version discriminator.

  - `String shortDescription`

    Short card/search description.

  - `String slug`

    Lowercase URL slug.

  - `Optional<String> logoUrl`

    Company logo URL, when known.

  - `Optional<String> primaryDomain`

    Canonical lowercase domain, when known.

  - `Optional<LocalDateTime> publishedAt`

    Publication time.

### Company Document Preview

- `class CompanyDocumentPreview:`

  Optional document card preview.

  - `Optional<String> description`

    Preview description.

  - `Optional<String> imageUrl`

    Preview image URL.

### Company Document Relation

- `enum CompanyDocumentRelation:`

  How a document relates to the company.

  - `SUBJECT("SUBJECT")`

  - `CONNECTED("CONNECTED")`

### Company Document Resource

- `class CompanyDocumentResource:`

  A company-level research or source document.

  - `CompanyDocumentType documentType`

    Typed document kind.

    - `COMPANY_PROFILE("COMPANY_PROFILE")`

    - `MARKET_RESEARCH("MARKET_RESEARCH")`

    - `INTERVIEW("INTERVIEW")`

    - `DEAL_SHEET("DEAL_SHEET")`

    - `PRESS_RELEASE("PRESS_RELEASE")`

    - `NEWS("NEWS")`

    - `OTHER("OTHER")`

  - `CompanyDocumentRelation relation`

    Relationship to this company.

    - `SUBJECT("SUBJECT")`

    - `CONNECTED("CONNECTED")`

  - `String title`

    Display title.

  - `String url`

    Document URL.

  - `Optional<String> externalId`

    Optional source identifier retained for reconciliation.

  - `Optional<CompanyDocumentPreview> preview`

    Optional card preview.

    - `Optional<String> description`

      Preview description.

    - `Optional<String> imageUrl`

      Preview image URL.

  - `Optional<LocalDateTime> publishedAt`

    Publication time, when known.

### Company Document Type

- `enum CompanyDocumentType:`

  Company document kind.

  - `COMPANY_PROFILE("COMPANY_PROFILE")`

  - `MARKET_RESEARCH("MARKET_RESEARCH")`

  - `INTERVIEW("INTERVIEW")`

  - `DEAL_SHEET("DEAL_SHEET")`

  - `PRESS_RELEASE("PRESS_RELEASE")`

  - `NEWS("NEWS")`

  - `OTHER("OTHER")`

### Company Headquarters

- `class CompanyHeadquarters:`

  Company headquarters.

  - `String city`

    City.

  - `String country`

    Country.

### Company Legal Entity

- `class CompanyLegalEntity:`

  A legal entity associated with the company.

  - `String country`

    Country name or ISO country code supplied by the source.

  - `String name`

    Legal name.

### Company Metric Point

- `class CompanyMetricPoint:`

  One metric observation.

  - `LocalDateTime observedAt`

    Observation time.

  - `String value`

    Exact decimal value, serialized as a string.

  - `MetricValueType valueType`

    Historical or estimated classification.

    - `HISTORICAL("HISTORICAL")`

    - `ESTIMATED("ESTIMATED")`

  - `Optional<List<String>> citationIds`

    Profile-local citation ids supporting this point.

  - `Optional<String> sourceEventId`

    Optional source event identifier.

  - `Optional<SourceMetadata> sourceMetadata`

    Optional provider reconciliation metadata.

### Company Metric Series

- `class CompanyMetricSeries:`

  A historical or estimated company metric series.

  - `MetricFrequency frequency`

    Observation cadence.

    - `YEAR("YEAR")`

    - `QUARTER("QUARTER")`

    - `MONTH("MONTH")`

    - `POINT_IN_TIME("POINT_IN_TIME")`

  - `String label`

    Display label.

  - `MetricKey metricKey`

    Canonical metric key.

    - `ANNUALIZED_REVENUE("ANNUALIZED_REVENUE")`

    - `REVENUE_GROWTH("REVENUE_GROWTH")`

    - `VALUATION("VALUATION")`

    - `ISSUE_PRICE("ISSUE_PRICE")`

    - `PRICE_PER_SHARE("PRICE_PER_SHARE")`

    - `AMOUNT_RAISED("AMOUNT_RAISED")`

    - `ORDER_VOLUME("ORDER_VOLUME")`

    - `PIPELINE_VALUE("PIPELINE_VALUE")`

    - `GROSS_MARGIN("GROSS_MARGIN")`

    - `EBIT_MARGIN("EBIT_MARGIN")`

    - `FCF_CONVERSION("FCF_CONVERSION")`

    - `CONTRACTED_REVENUE_PERCENT("CONTRACTED_REVENUE_PERCENT")`

    - `NET_REVENUE_RETENTION("NET_REVENUE_RETENTION")`

    - `CUSTOMER_COUNT("CUSTOMER_COUNT")`

    - `MARKET_POSITION("MARKET_POSITION")`

  - `String source`

    Publisher/provider name.

  - `MetricUnit unit`

    Value unit.

    - `USD("USD")`

    - `PERCENT("PERCENT")`

    - `COUNT("COUNT")`

    - `RANK("RANK")`

  - `Optional<String> externalId`

    Optional source identifier retained for reconciliation.

  - `Optional<List<CompanyMetricPoint>> points`

    Ordered observations.

    - `LocalDateTime observedAt`

      Observation time.

    - `String value`

      Exact decimal value, serialized as a string.

    - `MetricValueType valueType`

      Historical or estimated classification.

      - `HISTORICAL("HISTORICAL")`

      - `ESTIMATED("ESTIMATED")`

    - `Optional<List<String>> citationIds`

      Profile-local citation ids supporting this point.

    - `Optional<String> sourceEventId`

      Optional source event identifier.

    - `Optional<SourceMetadata> sourceMetadata`

      Optional provider reconciliation metadata.

  - `Optional<String> sourceUrl`

    Source URL, when available.

### Company Narrative Section

- `class CompanyNarrativeSection:`

  One ordered durable narrative block.

  - `String body`

    Plain-text section body.

  - `long displayOrder`

    Stable display position within the profile.

  - `String title`

    Section heading.

  - `Optional<List<String>> citationIds`

    Profile-local citation ids supporting this block.

### Company Person

- `class CompanyPerson:`

  A key person associated with the company.

  - `String name`

    Display name.

  - `Optional<String> externalId`

    Optional source identifier retained for reconciliation.

  - `Optional<List<CompanyPersonRole>> roles`

    One or more curated company roles.

    - `FOUNDER("FOUNDER")`

    - `CEO("CEO")`

    - `OTHER("OTHER")`

### Company Person Role

- `enum CompanyPersonRole:`

  A key person's relationship to the company.

  - `FOUNDER("FOUNDER")`

  - `CEO("CEO")`

  - `OTHER("OTHER")`

### Company Profile Resource

- `class CompanyProfileResource:`

  The complete versioned company profile (schema version one).

  - `Optional<List<CompanyCategory>> categories`

    Company categories.

    - `String name`

      Display name.

    - `String slug`

      Stable lowercase category slug.

  - `Optional<List<CompanyCitation>> citations`

    Sources referenced by narrative sections and metrics.

    - `String id`

      Stable profile-local citation identifier.

    - `String source`

      Source publisher or provider.

    - `String title`

      Human-readable source title.

    - `String url`

      Source URL.

    - `Optional<LocalDateTime> publishedAt`

      Source publication time, when known.

  - `Optional<List<CompanyCustomer>> customers`

    Named customers evidenced by the source material.

    - `String name`

      Customer name.

    - `Optional<String> logoUrl`

      Customer logo, when supplied.

  - `Optional<List<CompanyDocumentResource>> documents`

    Company-level research and source documents.

    - `CompanyDocumentType documentType`

      Typed document kind.

      - `COMPANY_PROFILE("COMPANY_PROFILE")`

      - `MARKET_RESEARCH("MARKET_RESEARCH")`

      - `INTERVIEW("INTERVIEW")`

      - `DEAL_SHEET("DEAL_SHEET")`

      - `PRESS_RELEASE("PRESS_RELEASE")`

      - `NEWS("NEWS")`

      - `OTHER("OTHER")`

    - `CompanyDocumentRelation relation`

      Relationship to this company.

      - `SUBJECT("SUBJECT")`

      - `CONNECTED("CONNECTED")`

    - `String title`

      Display title.

    - `String url`

      Document URL.

    - `Optional<String> externalId`

      Optional source identifier retained for reconciliation.

    - `Optional<CompanyDocumentPreview> preview`

      Optional card preview.

      - `Optional<String> description`

        Preview description.

      - `Optional<String> imageUrl`

        Preview image URL.

    - `Optional<LocalDateTime> publishedAt`

      Publication time, when known.

  - `Optional<CompanyHeadquarters> headquarters`

    Company headquarters, when known.

    - `String city`

      City.

    - `String country`

      Country.

  - `Optional<List<CompanyLegalEntity>> legalEntities`

    Known legal entities associated with the company.

    - `String country`

      Country name or ISO country code supplied by the source.

    - `String name`

      Legal name.

  - `Optional<List<CompanyMetricSeries>> metricSeries`

    Historical and estimated metric series.

    - `MetricFrequency frequency`

      Observation cadence.

      - `YEAR("YEAR")`

      - `QUARTER("QUARTER")`

      - `MONTH("MONTH")`

      - `POINT_IN_TIME("POINT_IN_TIME")`

    - `String label`

      Display label.

    - `MetricKey metricKey`

      Canonical metric key.

      - `ANNUALIZED_REVENUE("ANNUALIZED_REVENUE")`

      - `REVENUE_GROWTH("REVENUE_GROWTH")`

      - `VALUATION("VALUATION")`

      - `ISSUE_PRICE("ISSUE_PRICE")`

      - `PRICE_PER_SHARE("PRICE_PER_SHARE")`

      - `AMOUNT_RAISED("AMOUNT_RAISED")`

      - `ORDER_VOLUME("ORDER_VOLUME")`

      - `PIPELINE_VALUE("PIPELINE_VALUE")`

      - `GROSS_MARGIN("GROSS_MARGIN")`

      - `EBIT_MARGIN("EBIT_MARGIN")`

      - `FCF_CONVERSION("FCF_CONVERSION")`

      - `CONTRACTED_REVENUE_PERCENT("CONTRACTED_REVENUE_PERCENT")`

      - `NET_REVENUE_RETENTION("NET_REVENUE_RETENTION")`

      - `CUSTOMER_COUNT("CUSTOMER_COUNT")`

      - `MARKET_POSITION("MARKET_POSITION")`

    - `String source`

      Publisher/provider name.

    - `MetricUnit unit`

      Value unit.

      - `USD("USD")`

      - `PERCENT("PERCENT")`

      - `COUNT("COUNT")`

      - `RANK("RANK")`

    - `Optional<String> externalId`

      Optional source identifier retained for reconciliation.

    - `Optional<List<CompanyMetricPoint>> points`

      Ordered observations.

      - `LocalDateTime observedAt`

        Observation time.

      - `String value`

        Exact decimal value, serialized as a string.

      - `MetricValueType valueType`

        Historical or estimated classification.

        - `HISTORICAL("HISTORICAL")`

        - `ESTIMATED("ESTIMATED")`

      - `Optional<List<String>> citationIds`

        Profile-local citation ids supporting this point.

      - `Optional<String> sourceEventId`

        Optional source event identifier.

      - `Optional<SourceMetadata> sourceMetadata`

        Optional provider reconciliation metadata.

    - `Optional<String> sourceUrl`

      Source URL, when available.

  - `Optional<List<CompanyNarrativeSection>> narrativeSections`

    Ordered durable company fact and thesis blocks.

    - `String body`

      Plain-text section body.

    - `long displayOrder`

      Stable display position within the profile.

    - `String title`

      Section heading.

    - `Optional<List<String>> citationIds`

      Profile-local citation ids supporting this block.

  - `Optional<String> overview`

    Long company overview.

  - `Optional<List<CompanyPerson>> people`

    Key people and their roles.

    - `String name`

      Display name.

    - `Optional<String> externalId`

      Optional source identifier retained for reconciliation.

    - `Optional<List<CompanyPersonRole>> roles`

      One or more curated company roles.

      - `FOUNDER("FOUNDER")`

      - `CEO("CEO")`

      - `OTHER("OTHER")`

  - `Optional<List<CompanySocialLink>> social`

    Social/profile links.

    - `CompanySocialType type`

      Link type.

      - `WEBSITE("WEBSITE")`

      - `LINKEDIN("LINKEDIN")`

      - `X("X")`

      - `FACEBOOK("FACEBOOK")`

      - `OTHER("OTHER")`

    - `String url`

      Link URL.

  - `Optional<String> tagline`

    Short durable positioning line used with the company name.

### Company Social Link

- `class CompanySocialLink:`

  A company social/profile link.

  - `CompanySocialType type`

    Link type.

    - `WEBSITE("WEBSITE")`

    - `LINKEDIN("LINKEDIN")`

    - `X("X")`

    - `FACEBOOK("FACEBOOK")`

    - `OTHER("OTHER")`

  - `String url`

    Link URL.

### Company Social Type

- `enum CompanySocialType:`

  Kind of company social/profile link.

  - `WEBSITE("WEBSITE")`

  - `LINKEDIN("LINKEDIN")`

  - `X("X")`

  - `FACEBOOK("FACEBOOK")`

  - `OTHER("OTHER")`

### Metric Frequency

- `enum MetricFrequency:`

  Observation cadence for a metric series.

  - `YEAR("YEAR")`

  - `QUARTER("QUARTER")`

  - `MONTH("MONTH")`

  - `POINT_IN_TIME("POINT_IN_TIME")`

### Metric Key

- `enum MetricKey:`

  Canonical company metric key.

  - `ANNUALIZED_REVENUE("ANNUALIZED_REVENUE")`

  - `REVENUE_GROWTH("REVENUE_GROWTH")`

  - `VALUATION("VALUATION")`

  - `ISSUE_PRICE("ISSUE_PRICE")`

  - `PRICE_PER_SHARE("PRICE_PER_SHARE")`

  - `AMOUNT_RAISED("AMOUNT_RAISED")`

  - `ORDER_VOLUME("ORDER_VOLUME")`

  - `PIPELINE_VALUE("PIPELINE_VALUE")`

  - `GROSS_MARGIN("GROSS_MARGIN")`

  - `EBIT_MARGIN("EBIT_MARGIN")`

  - `FCF_CONVERSION("FCF_CONVERSION")`

  - `CONTRACTED_REVENUE_PERCENT("CONTRACTED_REVENUE_PERCENT")`

  - `NET_REVENUE_RETENTION("NET_REVENUE_RETENTION")`

  - `CUSTOMER_COUNT("CUSTOMER_COUNT")`

  - `MARKET_POSITION("MARKET_POSITION")`

# Iois

## Domain Types

### Ioi Company Resource

- `class IoiCompanyResource:`

  Company identity embedded in an IOI list item.

  - `String id`

  - `String name`

### Ioi Listing Resource

- `class IoiListingResource:`

  IOI list item with the campaign identity needed to render it.

  - `IoiCompanyResource company`

    Company identity embedded in an IOI list item.

    - `String id`

    - `String name`

  - `IoiOfferingResource offering`

    Offering identity embedded in an IOI list item.

    - `String id`

    - `String headline`

### Ioi Offering Resource

- `class IoiOfferingResource:`

  Offering identity embedded in an IOI list item.

  - `String id`

  - `String headline`

### Ioi Resource

- `class IoiResource:`

  One live indication of interest.

  - `String id`

  - `long accountId`

  - `LocalDateTime createdAt`

  - `Currency currency`

    Terms currency.

    - `USD("USD")`

  - `String notionalAmount`

  - `String offeringId`

  - `LocalDateTime updatedAt`

  - `Optional<NdaAcceptanceResource> ndaAcceptance`

    Most recent NDA acceptance linked to this IOI, if any.

    - `LocalDateTime acceptedAt`

    - `String agreementId`

    - `long version`

### 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.

  - `LocalDateTime acceptedAt`

  - `String agreementId`

  - `long version`

# Offerings

## List Offerings

`OfferingGetOfferingsResponse v1().privateMarkets().offerings().getOfferings(OfferingGetOfferingsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**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

- `OfferingGetOfferingsParams params`

  - `long accountId`

    Account whose account-holder entity must hold an accreditation
    attestation to browse private-market offerings.

### Returns

- `class OfferingGetOfferingsResponse:`

  - `List<OfferingCard> data`

    - `String id`

      Stable public identifier; IOIs and history hang off it.

    - `OfferingClass class_`

      Derived classification.

      - `UPCOMING("UPCOMING")`

      - `ACTIVE("ACTIVE")`

    - `OfferingCompany company`

      Owning company identity.

      - `String id`

        Stable company identifier.

      - `String name`

        Display name.

      - `String shortDescription`

        Short card/search description.

      - `String slug`

        Lowercase URL slug.

      - `Optional<String> logoUrl`

        Company logo URL, when known.

      - `Optional<String> primaryDomain`

        Canonical lowercase domain, when known.

    - `Currency currency`

      Terms currency.

      - `USD("USD")`

    - `String headline`

      Card/detail headline.

    - `String summary`

      Top opportunity paragraph.

    - `Optional<String> indicativePriceHigh`

      Indicative price-per-share range, high endpoint.

    - `Optional<String> indicativePriceLow`

      Indicative price-per-share range, low endpoint.

    - `Optional<ValuationBasis> indicativeValuationBasis`

      Meaning of the indicative valuation range.

      - `PRE_MONEY("PRE_MONEY")`

      - `POST_MONEY("POST_MONEY")`

      - `REFERENCE("REFERENCE")`

      - `IMPLIED("IMPLIED")`

    - `Optional<String> indicativeValuationHigh`

      Indicative valuation range, high endpoint.

    - `Optional<String> indicativeValuationLow`

      Indicative valuation range, low endpoint.

    - `Optional<LocalDateTime> ioiDeadline`

      Deadline for indications of interest.

    - `Optional<String> minimumIoiAmount`

      Minimum indication-of-interest amount.

    - `Optional<OfferingSpv> spv`

      Attached SPV identity and lifecycle, once one exists.

      - `String id`

        Stable SPV identifier.

      - `String name`

        Legal/display name.

      - `SpvStatus status`

        Lifecycle state.

        - `DRAFT("DRAFT")`

        - `OPEN("OPEN")`

        - `CLOSED("CLOSED")`

        - `LIQUIDATING("LIQUIDATING")`

        - `DISSOLVED("DISSOLVED")`

      - `Optional<String> custodianName`

        Custodian.

      - `Optional<String> managerName`

        SPV manager.

      - `Optional<NdaAgreementResource> ndaAgreement`

        Current NDA agreement. Absent when this SPV does not require one.

        - `String acceptanceText`

          Exact assent and authority representation shown to the signer.

        - `long acceptanceTextVersion`

          Version of the acceptance representation.

        - `String agreementId`

          Stable agreement identifier submitted with an IOI acceptance.

        - `String documentReference`

          Durable reference to the immutable NDA artifact.

        - `String documentSha256`

          Lowercase SHA-256 digest of the artifact bytes.

        - `LocalDateTime effectiveAt`

          Time this version became effective.

        - `long version`

          Strictly increasing SPV-local agreement version.

      - `Optional<String> shareClass`

        Underlying share class, when specified.

      - `Optional<String> structureDescription`

        Plain-text vehicle structure.

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.offerings.OfferingGetOfferingsParams;
import com.clearstreet.api.models.v1.privatemarkets.offerings.OfferingGetOfferingsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        OfferingGetOfferingsParams params = OfferingGetOfferingsParams.builder()
            .accountId(0L)
            .build();
        OfferingGetOfferingsResponse response = client.v1().privateMarkets().offerings().getOfferings(params);
    }
}
```

#### 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

`OfferingGetOfferingByIdResponse v1().privateMarkets().offerings().getOfferingById(OfferingGetOfferingByIdParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**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

- `OfferingGetOfferingByIdParams params`

  - `Optional<String> offeringId`

  - `long accountId`

    Account whose account-holder entity must hold an accreditation
    attestation to browse private-market offerings.

### Returns

- `class OfferingGetOfferingByIdResponse:`

  - `OfferingDetail data`

    One offering with everything needed to render its detail payload.

    - `Optional<String> disclosures`

      Important disclosures.

    - `Optional<List<OfferingDocumentResource>> documents`

      Campaign documents in display order.

      - `String id`

        Stable identifier.

      - `long displayOrder`

        Stable display position.

      - `OfferingDocumentType documentType`

        Document kind.

        - `TEARSHEET("TEARSHEET")`

        - `KEY_TERMS("KEY_TERMS")`

        - `RISK_FACTORS("RISK_FACTORS")`

        - `PPM("PPM")`

        - `OTHER("OTHER")`

      - `String title`

        Display title.

      - `Optional<String> objectKey`

        Object-store key, when the document is stored internally.

      - `Optional<LocalDateTime> publishedAt`

        Publication time, when known.

      - `Optional<String> source`

        Source publisher/provider.

      - `Optional<String> sourceUrl`

        Source URL.

      - `Optional<String> url`

        Externally reachable URL, when the document lives at one.

    - `Optional<List<OfferingHighlight>> highlights`

      Ordered resolved highlights.

      - `String label`

        Display label (the highlight's override, else the series' own label).

      - `String metricKey`

        Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`).

      - `MetricUnit unit`

        Value unit.

        - `USD("USD")`

        - `PERCENT("PERCENT")`

        - `COUNT("COUNT")`

        - `RANK("RANK")`

      - `Optional<LocalDateTime> observedAt`

        Observation time of the latest value.

      - `Optional<String> value`

        Latest observed value, when the series carries any points.

      - `Optional<MetricValueType> valueType`

        Whether the latest value is historical or estimated.

        - `HISTORICAL("HISTORICAL")`

        - `ESTIMATED("ESTIMATED")`

    - `Optional<String> investmentThesis`

      Campaign-specific investment framing.

    - `Optional<List<OfferingKeyRisk>> keyRisks`

      Ordered key risks.

      - `String body`

        Plain-text risk body.

      - `String title`

        Risk heading.

      - `Optional<List<String>> citationIds`

        Profile-local citation ids supporting the risk.

    - `Optional<List<OfferingParticipantResource>> participants`

      Campaign participants in display order.

      - `String id`

        Stable identifier.

      - `long displayOrder`

        Stable display position.

      - `String name`

        Display name.

      - `ParticipantRole role`

        Presentation role.

        - `LEAD_INVESTOR("LEAD_INVESTOR")`

        - `CO_LEAD("CO_LEAD")`

        - `FUND_MANAGER("FUND_MANAGER")`

        - `PLACEMENT_AGENT("PLACEMENT_AGENT")`

    - `Optional<String> structureDescription`

      Vehicle/structure framing shown before typed SPV terms exist.

    - `Optional<String> whyNow`

      Why-now framing.

### Example

```java
package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.privatemarkets.offerings.OfferingGetOfferingByIdParams;
import com.clearstreet.api.models.v1.privatemarkets.offerings.OfferingGetOfferingByIdResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        OfferingGetOfferingByIdParams params = OfferingGetOfferingByIdParams.builder()
            .offeringId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .accountId(0L)
            .build();
        OfferingGetOfferingByIdResponse response = client.v1().privateMarkets().offerings().getOfferingById(params);
    }
}
```

#### 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

- `enum Currency:`

  Terms currency.

  - `USD("USD")`

### Metric Unit

- `enum MetricUnit:`

  Unit for a resolved highlight metric.

  - `USD("USD")`

  - `PERCENT("PERCENT")`

  - `COUNT("COUNT")`

  - `RANK("RANK")`

### Metric Value Type

- `enum MetricValueType:`

  Whether a resolved highlight value is observed or estimated.

  - `HISTORICAL("HISTORICAL")`

  - `ESTIMATED("ESTIMATED")`

### Nda Agreement Resource

- `class NdaAgreementResource:`

  Current NDA agreement for an SPV-backed deal.

  - `String acceptanceText`

    Exact assent and authority representation shown to the signer.

  - `long acceptanceTextVersion`

    Version of the acceptance representation.

  - `String agreementId`

    Stable agreement identifier submitted with an IOI acceptance.

  - `String documentReference`

    Durable reference to the immutable NDA artifact.

  - `String documentSha256`

    Lowercase SHA-256 digest of the artifact bytes.

  - `LocalDateTime effectiveAt`

    Time this version became effective.

  - `long version`

    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.

  - `String id`

    Stable public identifier; IOIs and history hang off it.

  - `OfferingClass class_`

    Derived classification.

    - `UPCOMING("UPCOMING")`

    - `ACTIVE("ACTIVE")`

  - `OfferingCompany company`

    Owning company identity.

    - `String id`

      Stable company identifier.

    - `String name`

      Display name.

    - `String shortDescription`

      Short card/search description.

    - `String slug`

      Lowercase URL slug.

    - `Optional<String> logoUrl`

      Company logo URL, when known.

    - `Optional<String> primaryDomain`

      Canonical lowercase domain, when known.

  - `Currency currency`

    Terms currency.

    - `USD("USD")`

  - `String headline`

    Card/detail headline.

  - `String summary`

    Top opportunity paragraph.

  - `Optional<String> indicativePriceHigh`

    Indicative price-per-share range, high endpoint.

  - `Optional<String> indicativePriceLow`

    Indicative price-per-share range, low endpoint.

  - `Optional<ValuationBasis> indicativeValuationBasis`

    Meaning of the indicative valuation range.

    - `PRE_MONEY("PRE_MONEY")`

    - `POST_MONEY("POST_MONEY")`

    - `REFERENCE("REFERENCE")`

    - `IMPLIED("IMPLIED")`

  - `Optional<String> indicativeValuationHigh`

    Indicative valuation range, high endpoint.

  - `Optional<String> indicativeValuationLow`

    Indicative valuation range, low endpoint.

  - `Optional<LocalDateTime> ioiDeadline`

    Deadline for indications of interest.

  - `Optional<String> minimumIoiAmount`

    Minimum indication-of-interest amount.

  - `Optional<OfferingSpv> spv`

    Attached SPV identity and lifecycle, once one exists.

    - `String id`

      Stable SPV identifier.

    - `String name`

      Legal/display name.

    - `SpvStatus status`

      Lifecycle state.

      - `DRAFT("DRAFT")`

      - `OPEN("OPEN")`

      - `CLOSED("CLOSED")`

      - `LIQUIDATING("LIQUIDATING")`

      - `DISSOLVED("DISSOLVED")`

    - `Optional<String> custodianName`

      Custodian.

    - `Optional<String> managerName`

      SPV manager.

    - `Optional<NdaAgreementResource> ndaAgreement`

      Current NDA agreement. Absent when this SPV does not require one.

      - `String acceptanceText`

        Exact assent and authority representation shown to the signer.

      - `long acceptanceTextVersion`

        Version of the acceptance representation.

      - `String agreementId`

        Stable agreement identifier submitted with an IOI acceptance.

      - `String documentReference`

        Durable reference to the immutable NDA artifact.

      - `String documentSha256`

        Lowercase SHA-256 digest of the artifact bytes.

      - `LocalDateTime effectiveAt`

        Time this version became effective.

      - `long version`

        Strictly increasing SPV-local agreement version.

    - `Optional<String> shareClass`

      Underlying share class, when specified.

    - `Optional<String> structureDescription`

      Plain-text vehicle structure.

### Offering Class

- `enum OfferingClass:`

  Derived offering classification.

  - `UPCOMING("UPCOMING")`

  - `ACTIVE("ACTIVE")`

### Offering Company

- `class OfferingCompany:`

  Company identity carried on an offering card/detail.

  - `String id`

    Stable company identifier.

  - `String name`

    Display name.

  - `String shortDescription`

    Short card/search description.

  - `String slug`

    Lowercase URL slug.

  - `Optional<String> logoUrl`

    Company logo URL, when known.

  - `Optional<String> primaryDomain`

    Canonical lowercase domain, when known.

### Offering Detail

- `class OfferingDetail:`

  One offering with everything needed to render its detail payload.

  - `Optional<String> disclosures`

    Important disclosures.

  - `Optional<List<OfferingDocumentResource>> documents`

    Campaign documents in display order.

    - `String id`

      Stable identifier.

    - `long displayOrder`

      Stable display position.

    - `OfferingDocumentType documentType`

      Document kind.

      - `TEARSHEET("TEARSHEET")`

      - `KEY_TERMS("KEY_TERMS")`

      - `RISK_FACTORS("RISK_FACTORS")`

      - `PPM("PPM")`

      - `OTHER("OTHER")`

    - `String title`

      Display title.

    - `Optional<String> objectKey`

      Object-store key, when the document is stored internally.

    - `Optional<LocalDateTime> publishedAt`

      Publication time, when known.

    - `Optional<String> source`

      Source publisher/provider.

    - `Optional<String> sourceUrl`

      Source URL.

    - `Optional<String> url`

      Externally reachable URL, when the document lives at one.

  - `Optional<List<OfferingHighlight>> highlights`

    Ordered resolved highlights.

    - `String label`

      Display label (the highlight's override, else the series' own label).

    - `String metricKey`

      Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`).

    - `MetricUnit unit`

      Value unit.

      - `USD("USD")`

      - `PERCENT("PERCENT")`

      - `COUNT("COUNT")`

      - `RANK("RANK")`

    - `Optional<LocalDateTime> observedAt`

      Observation time of the latest value.

    - `Optional<String> value`

      Latest observed value, when the series carries any points.

    - `Optional<MetricValueType> valueType`

      Whether the latest value is historical or estimated.

      - `HISTORICAL("HISTORICAL")`

      - `ESTIMATED("ESTIMATED")`

  - `Optional<String> investmentThesis`

    Campaign-specific investment framing.

  - `Optional<List<OfferingKeyRisk>> keyRisks`

    Ordered key risks.

    - `String body`

      Plain-text risk body.

    - `String title`

      Risk heading.

    - `Optional<List<String>> citationIds`

      Profile-local citation ids supporting the risk.

  - `Optional<List<OfferingParticipantResource>> participants`

    Campaign participants in display order.

    - `String id`

      Stable identifier.

    - `long displayOrder`

      Stable display position.

    - `String name`

      Display name.

    - `ParticipantRole role`

      Presentation role.

      - `LEAD_INVESTOR("LEAD_INVESTOR")`

      - `CO_LEAD("CO_LEAD")`

      - `FUND_MANAGER("FUND_MANAGER")`

      - `PLACEMENT_AGENT("PLACEMENT_AGENT")`

  - `Optional<String> structureDescription`

    Vehicle/structure framing shown before typed SPV terms exist.

  - `Optional<String> whyNow`

    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.

  - `String id`

    Stable identifier.

  - `long displayOrder`

    Stable display position.

  - `OfferingDocumentType documentType`

    Document kind.

    - `TEARSHEET("TEARSHEET")`

    - `KEY_TERMS("KEY_TERMS")`

    - `RISK_FACTORS("RISK_FACTORS")`

    - `PPM("PPM")`

    - `OTHER("OTHER")`

  - `String title`

    Display title.

  - `Optional<String> objectKey`

    Object-store key, when the document is stored internally.

  - `Optional<LocalDateTime> publishedAt`

    Publication time, when known.

  - `Optional<String> source`

    Source publisher/provider.

  - `Optional<String> sourceUrl`

    Source URL.

  - `Optional<String> url`

    Externally reachable URL, when the document lives at one.

### Offering Document Type

- `enum OfferingDocumentType:`

  Kind of campaign document.

  - `TEARSHEET("TEARSHEET")`

  - `KEY_TERMS("KEY_TERMS")`

  - `RISK_FACTORS("RISK_FACTORS")`

  - `PPM("PPM")`

  - `OTHER("OTHER")`

### Offering Highlight

- `class OfferingHighlight:`

  A curated highlight, resolved against the company profile's metric series.

  - `String label`

    Display label (the highlight's override, else the series' own label).

  - `String metricKey`

    Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`).

  - `MetricUnit unit`

    Value unit.

    - `USD("USD")`

    - `PERCENT("PERCENT")`

    - `COUNT("COUNT")`

    - `RANK("RANK")`

  - `Optional<LocalDateTime> observedAt`

    Observation time of the latest value.

  - `Optional<String> value`

    Latest observed value, when the series carries any points.

  - `Optional<MetricValueType> valueType`

    Whether the latest value is historical or estimated.

    - `HISTORICAL("HISTORICAL")`

    - `ESTIMATED("ESTIMATED")`

### Offering Key Risk

- `class OfferingKeyRisk:`

  One ordered key-risk block.

  - `String body`

    Plain-text risk body.

  - `String title`

    Risk heading.

  - `Optional<List<String>> citationIds`

    Profile-local citation ids supporting the risk.

### Offering Participant Resource

- `class OfferingParticipantResource:`

  An offering participant's display data.

  - `String id`

    Stable identifier.

  - `long displayOrder`

    Stable display position.

  - `String name`

    Display name.

  - `ParticipantRole role`

    Presentation role.

    - `LEAD_INVESTOR("LEAD_INVESTOR")`

    - `CO_LEAD("CO_LEAD")`

    - `FUND_MANAGER("FUND_MANAGER")`

    - `PLACEMENT_AGENT("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.

  - `String id`

    Stable SPV identifier.

  - `String name`

    Legal/display name.

  - `SpvStatus status`

    Lifecycle state.

    - `DRAFT("DRAFT")`

    - `OPEN("OPEN")`

    - `CLOSED("CLOSED")`

    - `LIQUIDATING("LIQUIDATING")`

    - `DISSOLVED("DISSOLVED")`

  - `Optional<String> custodianName`

    Custodian.

  - `Optional<String> managerName`

    SPV manager.

  - `Optional<NdaAgreementResource> ndaAgreement`

    Current NDA agreement. Absent when this SPV does not require one.

    - `String acceptanceText`

      Exact assent and authority representation shown to the signer.

    - `long acceptanceTextVersion`

      Version of the acceptance representation.

    - `String agreementId`

      Stable agreement identifier submitted with an IOI acceptance.

    - `String documentReference`

      Durable reference to the immutable NDA artifact.

    - `String documentSha256`

      Lowercase SHA-256 digest of the artifact bytes.

    - `LocalDateTime effectiveAt`

      Time this version became effective.

    - `long version`

      Strictly increasing SPV-local agreement version.

  - `Optional<String> shareClass`

    Underlying share class, when specified.

  - `Optional<String> structureDescription`

    Plain-text vehicle structure.

### Participant Role

- `enum ParticipantRole:`

  Presentation role of an offering participant.

  - `LEAD_INVESTOR("LEAD_INVESTOR")`

  - `CO_LEAD("CO_LEAD")`

  - `FUND_MANAGER("FUND_MANAGER")`

  - `PLACEMENT_AGENT("PLACEMENT_AGENT")`

### Spv Status

- `enum SpvStatus:`

  SPV lifecycle state.

  - `DRAFT("DRAFT")`

  - `OPEN("OPEN")`

  - `CLOSED("CLOSED")`

  - `LIQUIDATING("LIQUIDATING")`

  - `DISSOLVED("DISSOLVED")`

### Valuation Basis

- `enum ValuationBasis:`

  Meaning of an indicative valuation range or an SPV valuation.

  - `PRE_MONEY("PRE_MONEY")`

  - `POST_MONEY("POST_MONEY")`

  - `REFERENCE("REFERENCE")`

  - `IMPLIED("IMPLIED")`

# Spvs

## Domain Types

### Charged By

- `enum ChargedBy:`

  Party charging a fee.

  - `FUND_MANAGER("FUND_MANAGER")`

  - `CLEAR_STREET("CLEAR_STREET")`

  - `THIRD_PARTY("THIRD_PARTY")`

### Fee Frequency

- `enum FeeFrequency:`

  Fee timing/cadence.

  - `ONE_TIME("ONE_TIME")`

  - `ANNUAL("ANNUAL")`

  - `AT_EXIT("AT_EXIT")`

  - `PASS_THROUGH("PASS_THROUGH")`

### Fee Type

- `enum FeeType:`

  Kind of SPV fee.

  - `MANAGEMENT("MANAGEMENT")`

  - `CARRY("CARRY")`

  - `PLACEMENT("PLACEMENT")`

  - `ADMINISTRATIVE("ADMINISTRATIVE")`

  - `OTHER("OTHER")`

### Spv Detail

- `class SpvDetail:`

  An OPEN SPV's identity, exact economics, and typed fee schedule.

  - `String id`

    Stable SPV identifier.

  - `String companyId`

    Company whose shares the vehicle holds.

  - `Currency currency`

    Terms currency.

    - `USD("USD")`

  - `String name`

    Legal/display name.

  - `SpvStatus status`

    Lifecycle state.

    - `DRAFT("DRAFT")`

    - `OPEN("OPEN")`

    - `CLOSED("CLOSED")`

    - `LIQUIDATING("LIQUIDATING")`

    - `DISSOLVED("DISSOLVED")`

  - `Optional<String> allInPricePerShare`

    Price per share including fees.

  - `Optional<String> custodianName`

    Custodian.

  - `Optional<String> feePerShare`

    Per-share fee.

  - `Optional<List<SpvFeeTermResource>> feeTerms`

    Typed fee schedule.

    - `ChargedBy chargedBy`

      Charging party.

      - `FUND_MANAGER("FUND_MANAGER")`

      - `CLEAR_STREET("CLEAR_STREET")`

      - `THIRD_PARTY("THIRD_PARTY")`

    - `Currency currency`

      Terms currency.

    - `String description`

      Plain-text fee disclosure.

    - `FeeType feeType`

      Fee kind.

      - `MANAGEMENT("MANAGEMENT")`

      - `CARRY("CARRY")`

      - `PLACEMENT("PLACEMENT")`

      - `ADMINISTRATIVE("ADMINISTRATIVE")`

      - `OTHER("OTHER")`

    - `FeeFrequency frequency`

      Timing/cadence.

      - `ONE_TIME("ONE_TIME")`

      - `ANNUAL("ANNUAL")`

      - `AT_EXIT("AT_EXIT")`

      - `PASS_THROUGH("PASS_THROUGH")`

    - `Optional<String> amount`

      Exact fixed amount, when amount-based.

    - `Optional<String> durationYears`

      Charge duration in years, when specified.

    - `Optional<String> hurdleRate`

      Carry hurdle as a decimal fraction, when specified.

    - `Optional<String> rate`

      Decimal fraction between zero and one, when percentage-based.

  - `Optional<String> fundedPercent`

    Percentage of dollar allocation funded, derived from the allocation pair.

  - `Optional<LocalDateTime> fundingDeadline`

    Funding deadline.

  - `Optional<String> managerName`

    SPV manager.

  - `Optional<String> minimumInvestmentAmount`

    Minimum investment amount.

  - `Optional<LocalDateTime> openedAt`

    Time the vehicle opened.

  - `Optional<String> pricePerShare`

    Price per share excluding fees.

  - `Optional<String> remainingAllocationAmount`

    Remaining dollar allocation.

  - `Optional<String> remainingShareAllocation`

    Remaining share allocation.

  - `Optional<String> shareClass`

    Underlying share class, when specified.

  - `Optional<String> structureDescription`

    Plain-text vehicle structure.

  - `Optional<String> totalAllocationAmount`

    Total dollar allocation.

  - `Optional<String> totalShareAllocation`

    Total share allocation.

  - `Optional<String> valuation`

    Exact company valuation.

  - `Optional<ValuationBasis> valuationBasis`

    Meaning of `valuation`.

    - `PRE_MONEY("PRE_MONEY")`

    - `POST_MONEY("POST_MONEY")`

    - `REFERENCE("REFERENCE")`

    - `IMPLIED("IMPLIED")`

### Spv Fee Term Resource

- `class SpvFeeTermResource:`

  One typed SPV fee term.

  - `ChargedBy chargedBy`

    Charging party.

    - `FUND_MANAGER("FUND_MANAGER")`

    - `CLEAR_STREET("CLEAR_STREET")`

    - `THIRD_PARTY("THIRD_PARTY")`

  - `Currency currency`

    Terms currency.

    - `USD("USD")`

  - `String description`

    Plain-text fee disclosure.

  - `FeeType feeType`

    Fee kind.

    - `MANAGEMENT("MANAGEMENT")`

    - `CARRY("CARRY")`

    - `PLACEMENT("PLACEMENT")`

    - `ADMINISTRATIVE("ADMINISTRATIVE")`

    - `OTHER("OTHER")`

  - `FeeFrequency frequency`

    Timing/cadence.

    - `ONE_TIME("ONE_TIME")`

    - `ANNUAL("ANNUAL")`

    - `AT_EXIT("AT_EXIT")`

    - `PASS_THROUGH("PASS_THROUGH")`

  - `Optional<String> amount`

    Exact fixed amount, when amount-based.

  - `Optional<String> durationYears`

    Charge duration in years, when specified.

  - `Optional<String> hurdleRate`

    Carry hurdle as a decimal fraction, when specified.

  - `Optional<String> rate`

    Decimal fraction between zero and one, when percentage-based.