# Private Markets

## Get SPV

`client.V1.PrivateMarkets.GetSpvByID(ctx, spvID, query) (*V1PrivateMarketGetSpvByIDResponse, error)`

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

- `spvID string`

- `query V1PrivateMarketGetSpvByIDParams`

  - `AccountID param.Field[int64]`

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

### Returns

- `type V1PrivateMarketGetSpvByIDResponse struct{…}`

  - `Data SpvDetail`

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

    - `ID string`

      Stable SPV identifier.

    - `CompanyID string`

      Company whose shares the vehicle holds.

    - `Currency Currency`

      Terms currency.

      - `const CurrencyUsd Currency = "USD"`

    - `Name string`

      Legal/display name.

    - `Status SpvStatus`

      Lifecycle state.

      - `const SpvStatusDraft SpvStatus = "DRAFT"`

      - `const SpvStatusOpen SpvStatus = "OPEN"`

      - `const SpvStatusClosed SpvStatus = "CLOSED"`

      - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

      - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

    - `AllInPricePerShare string`

      Price per share including fees.

    - `CustodianName string`

      Custodian.

    - `FeePerShare string`

      Per-share fee.

    - `FeeTerms []SpvFeeTermResource`

      Typed fee schedule.

      - `ChargedBy ChargedBy`

        Charging party.

        - `const ChargedByFundManager ChargedBy = "FUND_MANAGER"`

        - `const ChargedByClearStreet ChargedBy = "CLEAR_STREET"`

        - `const ChargedByThirdParty ChargedBy = "THIRD_PARTY"`

      - `Currency Currency`

        Terms currency.

      - `Description string`

        Plain-text fee disclosure.

      - `FeeType FeeType`

        Fee kind.

        - `const FeeTypeManagement FeeType = "MANAGEMENT"`

        - `const FeeTypeCarry FeeType = "CARRY"`

        - `const FeeTypePlacement FeeType = "PLACEMENT"`

        - `const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"`

        - `const FeeTypeOther FeeType = "OTHER"`

      - `Frequency FeeFrequency`

        Timing/cadence.

        - `const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"`

        - `const FeeFrequencyAnnual FeeFrequency = "ANNUAL"`

        - `const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"`

        - `const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"`

      - `Amount string`

        Exact fixed amount, when amount-based.

      - `DurationYears string`

        Charge duration in years, when specified.

      - `HurdleRate string`

        Carry hurdle as a decimal fraction, when specified.

      - `Rate string`

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

    - `FundedPercent string`

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

    - `FundingDeadline Time`

      Funding deadline.

    - `ManagerName string`

      SPV manager.

    - `MinimumInvestmentAmount string`

      Minimum investment amount.

    - `OpenedAt Time`

      Time the vehicle opened.

    - `PricePerShare string`

      Price per share excluding fees.

    - `RemainingAllocationAmount string`

      Remaining dollar allocation.

    - `RemainingShareAllocation string`

      Remaining share allocation.

    - `ShareClass string`

      Underlying share class, when specified.

    - `StructureDescription string`

      Plain-text vehicle structure.

    - `TotalAllocationAmount string`

      Total dollar allocation.

    - `TotalShareAllocation string`

      Total share allocation.

    - `Valuation string`

      Exact company valuation.

    - `ValuationBasis ValuationBasis`

      Meaning of `valuation`.

      - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

      - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

      - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

      - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.GetSpvByID(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1PrivateMarketGetSpvByIDParams{
      AccountID: 0,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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.

`client.V1.PrivateMarkets.GetIois(ctx, query) (*V1PrivateMarketGetIoisResponse, error)`

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

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

### Parameters

- `query V1PrivateMarketGetIoisParams`

  - `AccountID param.Field[int64]`

### Returns

- `type V1PrivateMarketGetIoisResponse struct{…}`

  - `Data IoiListingResourceList`

    - `Company IoiCompanyResource`

      Company identity embedded in an IOI list item.

      - `ID string`

      - `Name string`

    - `Offering IoiOfferingResource`

      Offering identity embedded in an IOI list item.

      - `ID string`

      - `Headline string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.GetIois(context.TODO(), clearstreet.V1PrivateMarketGetIoisParams{
    AccountID: 0,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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.

`client.V1.PrivateMarkets.NewIoi(ctx, params) (*V1PrivateMarketNewIoiResponse, error)`

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

Create an IOI for a visible upcoming offering.

### Parameters

- `params V1PrivateMarketNewIoiParams`

  - `AccountID param.Field[int64]`

    Query param

  - `NotionalAmount param.Field[string]`

    Body param

  - `OfferingID param.Field[string]`

    Body param

  - `NdaAcceptance param.Field[V1PrivateMarketNewIoiParamsNdaAcceptance]`

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

    - `Accepted bool`

      Must be true; confirms affirmative assent.

    - `AgreementID string`

      Exact agreement id returned by offering detail.

    - `AuthorityConfirmed bool`

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

### Returns

- `type V1PrivateMarketNewIoiResponse struct{…}`

  - `Data IoiListingResource`

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

    - `Company IoiCompanyResource`

      Company identity embedded in an IOI list item.

      - `ID string`

      - `Name string`

    - `Offering IoiOfferingResource`

      Offering identity embedded in an IOI list item.

      - `ID string`

      - `Headline string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.NewIoi(context.TODO(), clearstreet.V1PrivateMarketNewIoiParams{
    AccountID: 0,
    NotionalAmount: "100000.00",
    OfferingID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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.

`client.V1.PrivateMarkets.UpdateIoi(ctx, ioiID, params) (*V1PrivateMarketUpdateIoiResponse, error)`

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

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

### Parameters

- `ioiID string`

- `params V1PrivateMarketUpdateIoiParams`

  - `AccountID param.Field[int64]`

    Query param

  - `NotionalAmount param.Field[string]`

    Body param

  - `NdaAcceptance param.Field[V1PrivateMarketUpdateIoiParamsNdaAcceptance]`

    Body param: 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.

    - `AgreementID string`

      Exact agreement id returned by offering detail.

    - `AuthorityConfirmed bool`

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

### Returns

- `type V1PrivateMarketUpdateIoiResponse struct{…}`

  - `Data IoiListingResource`

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

    - `Company IoiCompanyResource`

      Company identity embedded in an IOI list item.

      - `ID string`

      - `Name string`

    - `Offering IoiOfferingResource`

      Offering identity embedded in an IOI list item.

      - `ID string`

      - `Headline string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.UpdateIoi(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1PrivateMarketUpdateIoiParams{
      AccountID: 0,
      NotionalAmount: "125000.00",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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.

`client.V1.PrivateMarkets.DeleteIoi(ctx, ioiID, body) error`

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

Withdraw a live IOI. Repeating a withdrawal returns 404.

### Parameters

- `ioiID string`

- `body V1PrivateMarketDeleteIoiParams`

  - `AccountID param.Field[int64]`

### Example

```go
package main

import (
  "context"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  err := client.V1.PrivateMarkets.DeleteIoi(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1PrivateMarketDeleteIoiParams{
      AccountID: 0,
    },
  )
  if err != nil {
    panic(err.Error())
  }
}
```

## Get Company

`client.V1.PrivateMarkets.GetCompanyByID(ctx, companyID, query) (*V1PrivateMarketGetCompanyByIDResponse, error)`

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

- `companyID string`

- `query V1PrivateMarketGetCompanyByIDParams`

  - `AccountID param.Field[int64]`

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

### Returns

- `type V1PrivateMarketGetCompanyByIDResponse struct{…}`

  - `Data CompanyDetail`

    A company's identity and its complete published profile.

    - `ID string`

      Stable company identifier.

    - `Name string`

      Display name.

    - `Profile CompanyProfileResource`

      The complete versioned company profile.

      - `Categories []CompanyCategory`

        Company categories.

        - `Name string`

          Display name.

        - `Slug string`

          Stable lowercase category slug.

      - `Citations []CompanyCitation`

        Sources referenced by narrative sections and metrics.

        - `ID string`

          Stable profile-local citation identifier.

        - `Source string`

          Source publisher or provider.

        - `Title string`

          Human-readable source title.

        - `URL string`

          Source URL.

        - `PublishedAt Time`

          Source publication time, when known.

      - `Customers []CompanyCustomer`

        Named customers evidenced by the source material.

        - `Name string`

          Customer name.

        - `LogoURL string`

          Customer logo, when supplied.

      - `Documents []CompanyDocumentResource`

        Company-level research and source documents.

        - `DocumentType CompanyDocumentType`

          Typed document kind.

          - `const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"`

          - `const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"`

          - `const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"`

          - `const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"`

          - `const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"`

          - `const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"`

          - `const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"`

        - `Relation CompanyDocumentRelation`

          Relationship to this company.

          - `const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"`

          - `const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"`

        - `Title string`

          Display title.

        - `URL string`

          Document URL.

        - `ExternalID string`

          Optional source identifier retained for reconciliation.

        - `Preview CompanyDocumentPreview`

          Optional card preview.

          - `Description string`

            Preview description.

          - `ImageURL string`

            Preview image URL.

        - `PublishedAt Time`

          Publication time, when known.

      - `Headquarters CompanyHeadquarters`

        Company headquarters, when known.

        - `City string`

          City.

        - `Country string`

          Country.

      - `LegalEntities []CompanyLegalEntity`

        Known legal entities associated with the company.

        - `Country string`

          Country name or ISO country code supplied by the source.

        - `Name string`

          Legal name.

      - `MetricSeries []CompanyMetricSeries`

        Historical and estimated metric series.

        - `Frequency MetricFrequency`

          Observation cadence.

          - `const MetricFrequencyYear MetricFrequency = "YEAR"`

          - `const MetricFrequencyQuarter MetricFrequency = "QUARTER"`

          - `const MetricFrequencyMonth MetricFrequency = "MONTH"`

          - `const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"`

        - `Label string`

          Display label.

        - `MetricKey MetricKey`

          Canonical metric key.

          - `const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"`

          - `const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"`

          - `const MetricKeyValuation MetricKey = "VALUATION"`

          - `const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"`

          - `const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"`

          - `const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"`

          - `const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"`

          - `const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"`

          - `const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"`

          - `const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"`

          - `const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"`

          - `const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"`

          - `const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"`

          - `const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"`

          - `const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"`

        - `Source string`

          Publisher/provider name.

        - `Unit MetricUnit`

          Value unit.

          - `const MetricUnitUsd MetricUnit = "USD"`

          - `const MetricUnitPercent MetricUnit = "PERCENT"`

          - `const MetricUnitCount MetricUnit = "COUNT"`

          - `const MetricUnitRank MetricUnit = "RANK"`

        - `ExternalID string`

          Optional source identifier retained for reconciliation.

        - `Points []CompanyMetricPoint`

          Ordered observations.

          - `ObservedAt Time`

            Observation time.

          - `Value string`

            Exact decimal value, serialized as a string.

          - `ValueType MetricValueType`

            Historical or estimated classification.

            - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

            - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

          - `CitationIDs []string`

            Profile-local citation ids supporting this point.

          - `SourceEventID string`

            Optional source event identifier.

          - `SourceMetadata map[string, string]`

            Optional provider reconciliation metadata.

        - `SourceURL string`

          Source URL, when available.

      - `NarrativeSections []CompanyNarrativeSection`

        Ordered durable company fact and thesis blocks.

        - `Body string`

          Plain-text section body.

        - `DisplayOrder int64`

          Stable display position within the profile.

        - `Title string`

          Section heading.

        - `CitationIDs []string`

          Profile-local citation ids supporting this block.

      - `Overview string`

        Long company overview.

      - `People []CompanyPerson`

        Key people and their roles.

        - `Name string`

          Display name.

        - `ExternalID string`

          Optional source identifier retained for reconciliation.

        - `Roles []CompanyPersonRole`

          One or more curated company roles.

          - `const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"`

          - `const CompanyPersonRoleCeo CompanyPersonRole = "CEO"`

          - `const CompanyPersonRoleOther CompanyPersonRole = "OTHER"`

      - `Social []CompanySocialLink`

        Social/profile links.

        - `Type CompanySocialType`

          Link type.

          - `const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"`

          - `const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"`

          - `const CompanySocialTypeX CompanySocialType = "X"`

          - `const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"`

          - `const CompanySocialTypeOther CompanySocialType = "OTHER"`

        - `URL string`

          Link URL.

      - `Tagline string`

        Short durable positioning line used with the company name.

    - `ProfileSchemaVersion int64`

      Profile schema version discriminator.

    - `ShortDescription string`

      Short card/search description.

    - `Slug string`

      Lowercase URL slug.

    - `LogoURL string`

      Company logo URL, when known.

    - `PrimaryDomain string`

      Canonical lowercase domain, when known.

    - `PublishedAt Time`

      Publication time.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.GetCompanyByID(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1PrivateMarketGetCompanyByIDParams{
      AccountID: 0,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  }
}
```

# Companies

## Domain Types

### Company Category

- `type CompanyCategory struct{…}`

  A company category.

  - `Name string`

    Display name.

  - `Slug string`

    Stable lowercase category slug.

### Company Citation

- `type CompanyCitation struct{…}`

  A cited source.

  - `ID string`

    Stable profile-local citation identifier.

  - `Source string`

    Source publisher or provider.

  - `Title string`

    Human-readable source title.

  - `URL string`

    Source URL.

  - `PublishedAt Time`

    Source publication time, when known.

### Company Customer

- `type CompanyCustomer struct{…}`

  A named company customer.

  - `Name string`

    Customer name.

  - `LogoURL string`

    Customer logo, when supplied.

### Company Detail

- `type CompanyDetail struct{…}`

  A company's identity and its complete published profile.

  - `ID string`

    Stable company identifier.

  - `Name string`

    Display name.

  - `Profile CompanyProfileResource`

    The complete versioned company profile.

    - `Categories []CompanyCategory`

      Company categories.

      - `Name string`

        Display name.

      - `Slug string`

        Stable lowercase category slug.

    - `Citations []CompanyCitation`

      Sources referenced by narrative sections and metrics.

      - `ID string`

        Stable profile-local citation identifier.

      - `Source string`

        Source publisher or provider.

      - `Title string`

        Human-readable source title.

      - `URL string`

        Source URL.

      - `PublishedAt Time`

        Source publication time, when known.

    - `Customers []CompanyCustomer`

      Named customers evidenced by the source material.

      - `Name string`

        Customer name.

      - `LogoURL string`

        Customer logo, when supplied.

    - `Documents []CompanyDocumentResource`

      Company-level research and source documents.

      - `DocumentType CompanyDocumentType`

        Typed document kind.

        - `const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"`

        - `const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"`

        - `const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"`

        - `const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"`

        - `const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"`

        - `const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"`

        - `const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"`

      - `Relation CompanyDocumentRelation`

        Relationship to this company.

        - `const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"`

        - `const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"`

      - `Title string`

        Display title.

      - `URL string`

        Document URL.

      - `ExternalID string`

        Optional source identifier retained for reconciliation.

      - `Preview CompanyDocumentPreview`

        Optional card preview.

        - `Description string`

          Preview description.

        - `ImageURL string`

          Preview image URL.

      - `PublishedAt Time`

        Publication time, when known.

    - `Headquarters CompanyHeadquarters`

      Company headquarters, when known.

      - `City string`

        City.

      - `Country string`

        Country.

    - `LegalEntities []CompanyLegalEntity`

      Known legal entities associated with the company.

      - `Country string`

        Country name or ISO country code supplied by the source.

      - `Name string`

        Legal name.

    - `MetricSeries []CompanyMetricSeries`

      Historical and estimated metric series.

      - `Frequency MetricFrequency`

        Observation cadence.

        - `const MetricFrequencyYear MetricFrequency = "YEAR"`

        - `const MetricFrequencyQuarter MetricFrequency = "QUARTER"`

        - `const MetricFrequencyMonth MetricFrequency = "MONTH"`

        - `const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"`

      - `Label string`

        Display label.

      - `MetricKey MetricKey`

        Canonical metric key.

        - `const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"`

        - `const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"`

        - `const MetricKeyValuation MetricKey = "VALUATION"`

        - `const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"`

        - `const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"`

        - `const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"`

        - `const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"`

        - `const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"`

        - `const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"`

        - `const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"`

        - `const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"`

        - `const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"`

        - `const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"`

        - `const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"`

        - `const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"`

      - `Source string`

        Publisher/provider name.

      - `Unit MetricUnit`

        Value unit.

        - `const MetricUnitUsd MetricUnit = "USD"`

        - `const MetricUnitPercent MetricUnit = "PERCENT"`

        - `const MetricUnitCount MetricUnit = "COUNT"`

        - `const MetricUnitRank MetricUnit = "RANK"`

      - `ExternalID string`

        Optional source identifier retained for reconciliation.

      - `Points []CompanyMetricPoint`

        Ordered observations.

        - `ObservedAt Time`

          Observation time.

        - `Value string`

          Exact decimal value, serialized as a string.

        - `ValueType MetricValueType`

          Historical or estimated classification.

          - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

          - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

        - `CitationIDs []string`

          Profile-local citation ids supporting this point.

        - `SourceEventID string`

          Optional source event identifier.

        - `SourceMetadata map[string, string]`

          Optional provider reconciliation metadata.

      - `SourceURL string`

        Source URL, when available.

    - `NarrativeSections []CompanyNarrativeSection`

      Ordered durable company fact and thesis blocks.

      - `Body string`

        Plain-text section body.

      - `DisplayOrder int64`

        Stable display position within the profile.

      - `Title string`

        Section heading.

      - `CitationIDs []string`

        Profile-local citation ids supporting this block.

    - `Overview string`

      Long company overview.

    - `People []CompanyPerson`

      Key people and their roles.

      - `Name string`

        Display name.

      - `ExternalID string`

        Optional source identifier retained for reconciliation.

      - `Roles []CompanyPersonRole`

        One or more curated company roles.

        - `const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"`

        - `const CompanyPersonRoleCeo CompanyPersonRole = "CEO"`

        - `const CompanyPersonRoleOther CompanyPersonRole = "OTHER"`

    - `Social []CompanySocialLink`

      Social/profile links.

      - `Type CompanySocialType`

        Link type.

        - `const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"`

        - `const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"`

        - `const CompanySocialTypeX CompanySocialType = "X"`

        - `const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"`

        - `const CompanySocialTypeOther CompanySocialType = "OTHER"`

      - `URL string`

        Link URL.

    - `Tagline string`

      Short durable positioning line used with the company name.

  - `ProfileSchemaVersion int64`

    Profile schema version discriminator.

  - `ShortDescription string`

    Short card/search description.

  - `Slug string`

    Lowercase URL slug.

  - `LogoURL string`

    Company logo URL, when known.

  - `PrimaryDomain string`

    Canonical lowercase domain, when known.

  - `PublishedAt Time`

    Publication time.

### Company Document Preview

- `type CompanyDocumentPreview struct{…}`

  Optional document card preview.

  - `Description string`

    Preview description.

  - `ImageURL string`

    Preview image URL.

### Company Document Relation

- `type CompanyDocumentRelation string`

  How a document relates to the company.

  - `const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"`

  - `const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"`

### Company Document Resource

- `type CompanyDocumentResource struct{…}`

  A company-level research or source document.

  - `DocumentType CompanyDocumentType`

    Typed document kind.

    - `const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"`

    - `const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"`

    - `const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"`

    - `const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"`

    - `const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"`

    - `const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"`

    - `const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"`

  - `Relation CompanyDocumentRelation`

    Relationship to this company.

    - `const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"`

    - `const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"`

  - `Title string`

    Display title.

  - `URL string`

    Document URL.

  - `ExternalID string`

    Optional source identifier retained for reconciliation.

  - `Preview CompanyDocumentPreview`

    Optional card preview.

    - `Description string`

      Preview description.

    - `ImageURL string`

      Preview image URL.

  - `PublishedAt Time`

    Publication time, when known.

### Company Document Type

- `type CompanyDocumentType string`

  Company document kind.

  - `const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"`

  - `const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"`

  - `const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"`

  - `const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"`

  - `const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"`

  - `const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"`

  - `const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"`

### Company Headquarters

- `type CompanyHeadquarters struct{…}`

  Company headquarters.

  - `City string`

    City.

  - `Country string`

    Country.

### Company Legal Entity

- `type CompanyLegalEntity struct{…}`

  A legal entity associated with the company.

  - `Country string`

    Country name or ISO country code supplied by the source.

  - `Name string`

    Legal name.

### Company Metric Point

- `type CompanyMetricPoint struct{…}`

  One metric observation.

  - `ObservedAt Time`

    Observation time.

  - `Value string`

    Exact decimal value, serialized as a string.

  - `ValueType MetricValueType`

    Historical or estimated classification.

    - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

    - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

  - `CitationIDs []string`

    Profile-local citation ids supporting this point.

  - `SourceEventID string`

    Optional source event identifier.

  - `SourceMetadata map[string, string]`

    Optional provider reconciliation metadata.

### Company Metric Series

- `type CompanyMetricSeries struct{…}`

  A historical or estimated company metric series.

  - `Frequency MetricFrequency`

    Observation cadence.

    - `const MetricFrequencyYear MetricFrequency = "YEAR"`

    - `const MetricFrequencyQuarter MetricFrequency = "QUARTER"`

    - `const MetricFrequencyMonth MetricFrequency = "MONTH"`

    - `const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"`

  - `Label string`

    Display label.

  - `MetricKey MetricKey`

    Canonical metric key.

    - `const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"`

    - `const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"`

    - `const MetricKeyValuation MetricKey = "VALUATION"`

    - `const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"`

    - `const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"`

    - `const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"`

    - `const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"`

    - `const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"`

    - `const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"`

    - `const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"`

    - `const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"`

    - `const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"`

    - `const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"`

    - `const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"`

    - `const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"`

  - `Source string`

    Publisher/provider name.

  - `Unit MetricUnit`

    Value unit.

    - `const MetricUnitUsd MetricUnit = "USD"`

    - `const MetricUnitPercent MetricUnit = "PERCENT"`

    - `const MetricUnitCount MetricUnit = "COUNT"`

    - `const MetricUnitRank MetricUnit = "RANK"`

  - `ExternalID string`

    Optional source identifier retained for reconciliation.

  - `Points []CompanyMetricPoint`

    Ordered observations.

    - `ObservedAt Time`

      Observation time.

    - `Value string`

      Exact decimal value, serialized as a string.

    - `ValueType MetricValueType`

      Historical or estimated classification.

      - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

      - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

    - `CitationIDs []string`

      Profile-local citation ids supporting this point.

    - `SourceEventID string`

      Optional source event identifier.

    - `SourceMetadata map[string, string]`

      Optional provider reconciliation metadata.

  - `SourceURL string`

    Source URL, when available.

### Company Narrative Section

- `type CompanyNarrativeSection struct{…}`

  One ordered durable narrative block.

  - `Body string`

    Plain-text section body.

  - `DisplayOrder int64`

    Stable display position within the profile.

  - `Title string`

    Section heading.

  - `CitationIDs []string`

    Profile-local citation ids supporting this block.

### Company Person

- `type CompanyPerson struct{…}`

  A key person associated with the company.

  - `Name string`

    Display name.

  - `ExternalID string`

    Optional source identifier retained for reconciliation.

  - `Roles []CompanyPersonRole`

    One or more curated company roles.

    - `const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"`

    - `const CompanyPersonRoleCeo CompanyPersonRole = "CEO"`

    - `const CompanyPersonRoleOther CompanyPersonRole = "OTHER"`

### Company Person Role

- `type CompanyPersonRole string`

  A key person's relationship to the company.

  - `const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"`

  - `const CompanyPersonRoleCeo CompanyPersonRole = "CEO"`

  - `const CompanyPersonRoleOther CompanyPersonRole = "OTHER"`

### Company Profile Resource

- `type CompanyProfileResource struct{…}`

  The complete versioned company profile (schema version one).

  - `Categories []CompanyCategory`

    Company categories.

    - `Name string`

      Display name.

    - `Slug string`

      Stable lowercase category slug.

  - `Citations []CompanyCitation`

    Sources referenced by narrative sections and metrics.

    - `ID string`

      Stable profile-local citation identifier.

    - `Source string`

      Source publisher or provider.

    - `Title string`

      Human-readable source title.

    - `URL string`

      Source URL.

    - `PublishedAt Time`

      Source publication time, when known.

  - `Customers []CompanyCustomer`

    Named customers evidenced by the source material.

    - `Name string`

      Customer name.

    - `LogoURL string`

      Customer logo, when supplied.

  - `Documents []CompanyDocumentResource`

    Company-level research and source documents.

    - `DocumentType CompanyDocumentType`

      Typed document kind.

      - `const CompanyDocumentTypeCompanyProfile CompanyDocumentType = "COMPANY_PROFILE"`

      - `const CompanyDocumentTypeMarketResearch CompanyDocumentType = "MARKET_RESEARCH"`

      - `const CompanyDocumentTypeInterview CompanyDocumentType = "INTERVIEW"`

      - `const CompanyDocumentTypeDealSheet CompanyDocumentType = "DEAL_SHEET"`

      - `const CompanyDocumentTypePressRelease CompanyDocumentType = "PRESS_RELEASE"`

      - `const CompanyDocumentTypeNews CompanyDocumentType = "NEWS"`

      - `const CompanyDocumentTypeOther CompanyDocumentType = "OTHER"`

    - `Relation CompanyDocumentRelation`

      Relationship to this company.

      - `const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"`

      - `const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"`

    - `Title string`

      Display title.

    - `URL string`

      Document URL.

    - `ExternalID string`

      Optional source identifier retained for reconciliation.

    - `Preview CompanyDocumentPreview`

      Optional card preview.

      - `Description string`

        Preview description.

      - `ImageURL string`

        Preview image URL.

    - `PublishedAt Time`

      Publication time, when known.

  - `Headquarters CompanyHeadquarters`

    Company headquarters, when known.

    - `City string`

      City.

    - `Country string`

      Country.

  - `LegalEntities []CompanyLegalEntity`

    Known legal entities associated with the company.

    - `Country string`

      Country name or ISO country code supplied by the source.

    - `Name string`

      Legal name.

  - `MetricSeries []CompanyMetricSeries`

    Historical and estimated metric series.

    - `Frequency MetricFrequency`

      Observation cadence.

      - `const MetricFrequencyYear MetricFrequency = "YEAR"`

      - `const MetricFrequencyQuarter MetricFrequency = "QUARTER"`

      - `const MetricFrequencyMonth MetricFrequency = "MONTH"`

      - `const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"`

    - `Label string`

      Display label.

    - `MetricKey MetricKey`

      Canonical metric key.

      - `const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"`

      - `const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"`

      - `const MetricKeyValuation MetricKey = "VALUATION"`

      - `const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"`

      - `const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"`

      - `const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"`

      - `const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"`

      - `const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"`

      - `const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"`

      - `const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"`

      - `const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"`

      - `const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"`

      - `const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"`

      - `const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"`

      - `const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"`

    - `Source string`

      Publisher/provider name.

    - `Unit MetricUnit`

      Value unit.

      - `const MetricUnitUsd MetricUnit = "USD"`

      - `const MetricUnitPercent MetricUnit = "PERCENT"`

      - `const MetricUnitCount MetricUnit = "COUNT"`

      - `const MetricUnitRank MetricUnit = "RANK"`

    - `ExternalID string`

      Optional source identifier retained for reconciliation.

    - `Points []CompanyMetricPoint`

      Ordered observations.

      - `ObservedAt Time`

        Observation time.

      - `Value string`

        Exact decimal value, serialized as a string.

      - `ValueType MetricValueType`

        Historical or estimated classification.

        - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

        - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

      - `CitationIDs []string`

        Profile-local citation ids supporting this point.

      - `SourceEventID string`

        Optional source event identifier.

      - `SourceMetadata map[string, string]`

        Optional provider reconciliation metadata.

    - `SourceURL string`

      Source URL, when available.

  - `NarrativeSections []CompanyNarrativeSection`

    Ordered durable company fact and thesis blocks.

    - `Body string`

      Plain-text section body.

    - `DisplayOrder int64`

      Stable display position within the profile.

    - `Title string`

      Section heading.

    - `CitationIDs []string`

      Profile-local citation ids supporting this block.

  - `Overview string`

    Long company overview.

  - `People []CompanyPerson`

    Key people and their roles.

    - `Name string`

      Display name.

    - `ExternalID string`

      Optional source identifier retained for reconciliation.

    - `Roles []CompanyPersonRole`

      One or more curated company roles.

      - `const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"`

      - `const CompanyPersonRoleCeo CompanyPersonRole = "CEO"`

      - `const CompanyPersonRoleOther CompanyPersonRole = "OTHER"`

  - `Social []CompanySocialLink`

    Social/profile links.

    - `Type CompanySocialType`

      Link type.

      - `const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"`

      - `const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"`

      - `const CompanySocialTypeX CompanySocialType = "X"`

      - `const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"`

      - `const CompanySocialTypeOther CompanySocialType = "OTHER"`

    - `URL string`

      Link URL.

  - `Tagline string`

    Short durable positioning line used with the company name.

### Company Social Link

- `type CompanySocialLink struct{…}`

  A company social/profile link.

  - `Type CompanySocialType`

    Link type.

    - `const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"`

    - `const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"`

    - `const CompanySocialTypeX CompanySocialType = "X"`

    - `const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"`

    - `const CompanySocialTypeOther CompanySocialType = "OTHER"`

  - `URL string`

    Link URL.

### Company Social Type

- `type CompanySocialType string`

  Kind of company social/profile link.

  - `const CompanySocialTypeWebsite CompanySocialType = "WEBSITE"`

  - `const CompanySocialTypeLinkedin CompanySocialType = "LINKEDIN"`

  - `const CompanySocialTypeX CompanySocialType = "X"`

  - `const CompanySocialTypeFacebook CompanySocialType = "FACEBOOK"`

  - `const CompanySocialTypeOther CompanySocialType = "OTHER"`

### Metric Frequency

- `type MetricFrequency string`

  Observation cadence for a metric series.

  - `const MetricFrequencyYear MetricFrequency = "YEAR"`

  - `const MetricFrequencyQuarter MetricFrequency = "QUARTER"`

  - `const MetricFrequencyMonth MetricFrequency = "MONTH"`

  - `const MetricFrequencyPointInTime MetricFrequency = "POINT_IN_TIME"`

### Metric Key

- `type MetricKey string`

  Canonical company metric key.

  - `const MetricKeyAnnualizedRevenue MetricKey = "ANNUALIZED_REVENUE"`

  - `const MetricKeyRevenueGrowth MetricKey = "REVENUE_GROWTH"`

  - `const MetricKeyValuation MetricKey = "VALUATION"`

  - `const MetricKeyIssuePrice MetricKey = "ISSUE_PRICE"`

  - `const MetricKeyPricePerShare MetricKey = "PRICE_PER_SHARE"`

  - `const MetricKeyAmountRaised MetricKey = "AMOUNT_RAISED"`

  - `const MetricKeyOrderVolume MetricKey = "ORDER_VOLUME"`

  - `const MetricKeyPipelineValue MetricKey = "PIPELINE_VALUE"`

  - `const MetricKeyGrossMargin MetricKey = "GROSS_MARGIN"`

  - `const MetricKeyEbitMargin MetricKey = "EBIT_MARGIN"`

  - `const MetricKeyFcfConversion MetricKey = "FCF_CONVERSION"`

  - `const MetricKeyContractedRevenuePercent MetricKey = "CONTRACTED_REVENUE_PERCENT"`

  - `const MetricKeyNetRevenueRetention MetricKey = "NET_REVENUE_RETENTION"`

  - `const MetricKeyCustomerCount MetricKey = "CUSTOMER_COUNT"`

  - `const MetricKeyMarketPosition MetricKey = "MARKET_POSITION"`

# Iois

## Domain Types

### Ioi Company Resource

- `type IoiCompanyResource struct{…}`

  Company identity embedded in an IOI list item.

  - `ID string`

  - `Name string`

### Ioi Listing Resource

- `type IoiListingResource struct{…}`

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

  - `Company IoiCompanyResource`

    Company identity embedded in an IOI list item.

    - `ID string`

    - `Name string`

  - `Offering IoiOfferingResource`

    Offering identity embedded in an IOI list item.

    - `ID string`

    - `Headline string`

### Ioi Listing Resource List

- `type IoiListingResourceList []IoiListingResource`

  - `Company IoiCompanyResource`

    Company identity embedded in an IOI list item.

    - `ID string`

    - `Name string`

  - `Offering IoiOfferingResource`

    Offering identity embedded in an IOI list item.

    - `ID string`

    - `Headline string`

### Ioi Offering Resource

- `type IoiOfferingResource struct{…}`

  Offering identity embedded in an IOI list item.

  - `ID string`

  - `Headline string`

### Ioi Resource

- `type IoiResource struct{…}`

  One live indication of interest.

  - `ID string`

  - `AccountID int64`

  - `CreatedAt Time`

  - `Currency Currency`

    Terms currency.

    - `const CurrencyUsd Currency = "USD"`

  - `NotionalAmount string`

  - `OfferingID string`

  - `UpdatedAt Time`

  - `NdaAcceptance NdaAcceptanceResource`

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

    - `AcceptedAt Time`

    - `AgreementID string`

    - `Version int64`

### Nda Acceptance Resource

- `type NdaAcceptanceResource struct{…}`

  Public evidence that an NDA version was accepted. Signing IP and other
  provenance remain audit-only and are never returned by this API.

  - `AcceptedAt Time`

  - `AgreementID string`

  - `Version int64`

# Offerings

## List Offerings

`client.V1.PrivateMarkets.Offerings.GetOfferings(ctx, query) (*V1PrivateMarketOfferingGetOfferingsResponse, error)`

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

- `query V1PrivateMarketOfferingGetOfferingsParams`

  - `AccountID param.Field[int64]`

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

### Returns

- `type V1PrivateMarketOfferingGetOfferingsResponse struct{…}`

  - `Data OfferingCardList`

    - `ID string`

      Stable public identifier; IOIs and history hang off it.

    - `Class OfferingClass`

      Derived classification.

      - `const OfferingClassUpcoming OfferingClass = "UPCOMING"`

      - `const OfferingClassActive OfferingClass = "ACTIVE"`

    - `Company OfferingCompany`

      Owning company identity.

      - `ID string`

        Stable company identifier.

      - `Name string`

        Display name.

      - `ShortDescription string`

        Short card/search description.

      - `Slug string`

        Lowercase URL slug.

      - `LogoURL string`

        Company logo URL, when known.

      - `PrimaryDomain string`

        Canonical lowercase domain, when known.

    - `Currency Currency`

      Terms currency.

      - `const CurrencyUsd Currency = "USD"`

    - `Headline string`

      Card/detail headline.

    - `Summary string`

      Top opportunity paragraph.

    - `IndicativePriceHigh string`

      Indicative price-per-share range, high endpoint.

    - `IndicativePriceLow string`

      Indicative price-per-share range, low endpoint.

    - `IndicativeValuationBasis ValuationBasis`

      Meaning of the indicative valuation range.

      - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

      - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

      - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

      - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

    - `IndicativeValuationHigh string`

      Indicative valuation range, high endpoint.

    - `IndicativeValuationLow string`

      Indicative valuation range, low endpoint.

    - `IoiDeadline Time`

      Deadline for indications of interest.

    - `MinimumIoiAmount string`

      Minimum indication-of-interest amount.

    - `Spv OfferingSpv`

      Attached SPV identity and lifecycle, once one exists.

      - `ID string`

        Stable SPV identifier.

      - `Name string`

        Legal/display name.

      - `Status SpvStatus`

        Lifecycle state.

        - `const SpvStatusDraft SpvStatus = "DRAFT"`

        - `const SpvStatusOpen SpvStatus = "OPEN"`

        - `const SpvStatusClosed SpvStatus = "CLOSED"`

        - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

        - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

      - `CustodianName string`

        Custodian.

      - `ManagerName string`

        SPV manager.

      - `NdaAgreement NdaAgreementResource`

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

        - `AcceptanceText string`

          Exact assent and authority representation shown to the signer.

        - `AcceptanceTextVersion int64`

          Version of the acceptance representation.

        - `AgreementID string`

          Stable agreement identifier submitted with an IOI acceptance.

        - `DocumentReference string`

          Durable reference to the immutable NDA artifact.

        - `DocumentSha256 string`

          Lowercase SHA-256 digest of the artifact bytes.

        - `EffectiveAt Time`

          Time this version became effective.

        - `Version int64`

          Strictly increasing SPV-local agreement version.

      - `ShareClass string`

        Underlying share class, when specified.

      - `StructureDescription string`

        Plain-text vehicle structure.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.Offerings.GetOfferings(context.TODO(), clearstreet.V1PrivateMarketOfferingGetOfferingsParams{
    AccountID: 0,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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

`client.V1.PrivateMarkets.Offerings.GetOfferingByID(ctx, offeringID, query) (*V1PrivateMarketOfferingGetOfferingByIDResponse, error)`

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

- `offeringID string`

- `query V1PrivateMarketOfferingGetOfferingByIDParams`

  - `AccountID param.Field[int64]`

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

### Returns

- `type V1PrivateMarketOfferingGetOfferingByIDResponse struct{…}`

  - `Data OfferingDetail`

    One offering with everything needed to render its detail payload.

    - `Disclosures string`

      Important disclosures.

    - `Documents []OfferingDocumentResource`

      Campaign documents in display order.

      - `ID string`

        Stable identifier.

      - `DisplayOrder int64`

        Stable display position.

      - `DocumentType OfferingDocumentType`

        Document kind.

        - `const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"`

        - `const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"`

        - `const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"`

        - `const OfferingDocumentTypePpm OfferingDocumentType = "PPM"`

        - `const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"`

      - `Title string`

        Display title.

      - `ObjectKey string`

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

      - `PublishedAt Time`

        Publication time, when known.

      - `Source string`

        Source publisher/provider.

      - `SourceURL string`

        Source URL.

      - `URL string`

        Externally reachable URL, when the document lives at one.

    - `Highlights []OfferingHighlight`

      Ordered resolved highlights.

      - `Label string`

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

      - `MetricKey string`

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

      - `Unit MetricUnit`

        Value unit.

        - `const MetricUnitUsd MetricUnit = "USD"`

        - `const MetricUnitPercent MetricUnit = "PERCENT"`

        - `const MetricUnitCount MetricUnit = "COUNT"`

        - `const MetricUnitRank MetricUnit = "RANK"`

      - `ObservedAt Time`

        Observation time of the latest value.

      - `Value string`

        Latest observed value, when the series carries any points.

      - `ValueType MetricValueType`

        Whether the latest value is historical or estimated.

        - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

        - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

    - `InvestmentThesis string`

      Campaign-specific investment framing.

    - `KeyRisks []OfferingKeyRisk`

      Ordered key risks.

      - `Body string`

        Plain-text risk body.

      - `Title string`

        Risk heading.

      - `CitationIDs []string`

        Profile-local citation ids supporting the risk.

    - `Participants []OfferingParticipantResource`

      Campaign participants in display order.

      - `ID string`

        Stable identifier.

      - `DisplayOrder int64`

        Stable display position.

      - `Name string`

        Display name.

      - `Role ParticipantRole`

        Presentation role.

        - `const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"`

        - `const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"`

        - `const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"`

        - `const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"`

    - `StructureDescription string`

      Vehicle/structure framing shown before typed SPV terms exist.

    - `WhyNow string`

      Why-now framing.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.PrivateMarkets.Offerings.GetOfferingByID(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1PrivateMarketOfferingGetOfferingByIDParams{
      AccountID: 0,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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

- `type Currency string`

  Terms currency.

  - `const CurrencyUsd Currency = "USD"`

### Metric Unit

- `type MetricUnit string`

  Unit for a resolved highlight metric.

  - `const MetricUnitUsd MetricUnit = "USD"`

  - `const MetricUnitPercent MetricUnit = "PERCENT"`

  - `const MetricUnitCount MetricUnit = "COUNT"`

  - `const MetricUnitRank MetricUnit = "RANK"`

### Metric Value Type

- `type MetricValueType string`

  Whether a resolved highlight value is observed or estimated.

  - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

  - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

### Nda Agreement Resource

- `type NdaAgreementResource struct{…}`

  Current NDA agreement for an SPV-backed deal.

  - `AcceptanceText string`

    Exact assent and authority representation shown to the signer.

  - `AcceptanceTextVersion int64`

    Version of the acceptance representation.

  - `AgreementID string`

    Stable agreement identifier submitted with an IOI acceptance.

  - `DocumentReference string`

    Durable reference to the immutable NDA artifact.

  - `DocumentSha256 string`

    Lowercase SHA-256 digest of the artifact bytes.

  - `EffectiveAt Time`

    Time this version became effective.

  - `Version int64`

    Strictly increasing SPV-local agreement version.

### Offering Card

- `type OfferingCard struct{…}`

  One offering as it appears in a list: its derived class, indicative terms,
  a company identity summary, and any attached SPV.

  - `ID string`

    Stable public identifier; IOIs and history hang off it.

  - `Class OfferingClass`

    Derived classification.

    - `const OfferingClassUpcoming OfferingClass = "UPCOMING"`

    - `const OfferingClassActive OfferingClass = "ACTIVE"`

  - `Company OfferingCompany`

    Owning company identity.

    - `ID string`

      Stable company identifier.

    - `Name string`

      Display name.

    - `ShortDescription string`

      Short card/search description.

    - `Slug string`

      Lowercase URL slug.

    - `LogoURL string`

      Company logo URL, when known.

    - `PrimaryDomain string`

      Canonical lowercase domain, when known.

  - `Currency Currency`

    Terms currency.

    - `const CurrencyUsd Currency = "USD"`

  - `Headline string`

    Card/detail headline.

  - `Summary string`

    Top opportunity paragraph.

  - `IndicativePriceHigh string`

    Indicative price-per-share range, high endpoint.

  - `IndicativePriceLow string`

    Indicative price-per-share range, low endpoint.

  - `IndicativeValuationBasis ValuationBasis`

    Meaning of the indicative valuation range.

    - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

    - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

    - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

    - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

  - `IndicativeValuationHigh string`

    Indicative valuation range, high endpoint.

  - `IndicativeValuationLow string`

    Indicative valuation range, low endpoint.

  - `IoiDeadline Time`

    Deadline for indications of interest.

  - `MinimumIoiAmount string`

    Minimum indication-of-interest amount.

  - `Spv OfferingSpv`

    Attached SPV identity and lifecycle, once one exists.

    - `ID string`

      Stable SPV identifier.

    - `Name string`

      Legal/display name.

    - `Status SpvStatus`

      Lifecycle state.

      - `const SpvStatusDraft SpvStatus = "DRAFT"`

      - `const SpvStatusOpen SpvStatus = "OPEN"`

      - `const SpvStatusClosed SpvStatus = "CLOSED"`

      - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

      - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

    - `CustodianName string`

      Custodian.

    - `ManagerName string`

      SPV manager.

    - `NdaAgreement NdaAgreementResource`

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

      - `AcceptanceText string`

        Exact assent and authority representation shown to the signer.

      - `AcceptanceTextVersion int64`

        Version of the acceptance representation.

      - `AgreementID string`

        Stable agreement identifier submitted with an IOI acceptance.

      - `DocumentReference string`

        Durable reference to the immutable NDA artifact.

      - `DocumentSha256 string`

        Lowercase SHA-256 digest of the artifact bytes.

      - `EffectiveAt Time`

        Time this version became effective.

      - `Version int64`

        Strictly increasing SPV-local agreement version.

    - `ShareClass string`

      Underlying share class, when specified.

    - `StructureDescription string`

      Plain-text vehicle structure.

### Offering Card List

- `type OfferingCardList []OfferingCard`

  - `ID string`

    Stable public identifier; IOIs and history hang off it.

  - `Class OfferingClass`

    Derived classification.

    - `const OfferingClassUpcoming OfferingClass = "UPCOMING"`

    - `const OfferingClassActive OfferingClass = "ACTIVE"`

  - `Company OfferingCompany`

    Owning company identity.

    - `ID string`

      Stable company identifier.

    - `Name string`

      Display name.

    - `ShortDescription string`

      Short card/search description.

    - `Slug string`

      Lowercase URL slug.

    - `LogoURL string`

      Company logo URL, when known.

    - `PrimaryDomain string`

      Canonical lowercase domain, when known.

  - `Currency Currency`

    Terms currency.

    - `const CurrencyUsd Currency = "USD"`

  - `Headline string`

    Card/detail headline.

  - `Summary string`

    Top opportunity paragraph.

  - `IndicativePriceHigh string`

    Indicative price-per-share range, high endpoint.

  - `IndicativePriceLow string`

    Indicative price-per-share range, low endpoint.

  - `IndicativeValuationBasis ValuationBasis`

    Meaning of the indicative valuation range.

    - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

    - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

    - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

    - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

  - `IndicativeValuationHigh string`

    Indicative valuation range, high endpoint.

  - `IndicativeValuationLow string`

    Indicative valuation range, low endpoint.

  - `IoiDeadline Time`

    Deadline for indications of interest.

  - `MinimumIoiAmount string`

    Minimum indication-of-interest amount.

  - `Spv OfferingSpv`

    Attached SPV identity and lifecycle, once one exists.

    - `ID string`

      Stable SPV identifier.

    - `Name string`

      Legal/display name.

    - `Status SpvStatus`

      Lifecycle state.

      - `const SpvStatusDraft SpvStatus = "DRAFT"`

      - `const SpvStatusOpen SpvStatus = "OPEN"`

      - `const SpvStatusClosed SpvStatus = "CLOSED"`

      - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

      - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

    - `CustodianName string`

      Custodian.

    - `ManagerName string`

      SPV manager.

    - `NdaAgreement NdaAgreementResource`

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

      - `AcceptanceText string`

        Exact assent and authority representation shown to the signer.

      - `AcceptanceTextVersion int64`

        Version of the acceptance representation.

      - `AgreementID string`

        Stable agreement identifier submitted with an IOI acceptance.

      - `DocumentReference string`

        Durable reference to the immutable NDA artifact.

      - `DocumentSha256 string`

        Lowercase SHA-256 digest of the artifact bytes.

      - `EffectiveAt Time`

        Time this version became effective.

      - `Version int64`

        Strictly increasing SPV-local agreement version.

    - `ShareClass string`

      Underlying share class, when specified.

    - `StructureDescription string`

      Plain-text vehicle structure.

### Offering Class

- `type OfferingClass string`

  Derived offering classification.

  - `const OfferingClassUpcoming OfferingClass = "UPCOMING"`

  - `const OfferingClassActive OfferingClass = "ACTIVE"`

### Offering Company

- `type OfferingCompany struct{…}`

  Company identity carried on an offering card/detail.

  - `ID string`

    Stable company identifier.

  - `Name string`

    Display name.

  - `ShortDescription string`

    Short card/search description.

  - `Slug string`

    Lowercase URL slug.

  - `LogoURL string`

    Company logo URL, when known.

  - `PrimaryDomain string`

    Canonical lowercase domain, when known.

### Offering Detail

- `type OfferingDetail struct{…}`

  One offering with everything needed to render its detail payload.

  - `Disclosures string`

    Important disclosures.

  - `Documents []OfferingDocumentResource`

    Campaign documents in display order.

    - `ID string`

      Stable identifier.

    - `DisplayOrder int64`

      Stable display position.

    - `DocumentType OfferingDocumentType`

      Document kind.

      - `const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"`

      - `const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"`

      - `const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"`

      - `const OfferingDocumentTypePpm OfferingDocumentType = "PPM"`

      - `const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"`

    - `Title string`

      Display title.

    - `ObjectKey string`

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

    - `PublishedAt Time`

      Publication time, when known.

    - `Source string`

      Source publisher/provider.

    - `SourceURL string`

      Source URL.

    - `URL string`

      Externally reachable URL, when the document lives at one.

  - `Highlights []OfferingHighlight`

    Ordered resolved highlights.

    - `Label string`

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

    - `MetricKey string`

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

    - `Unit MetricUnit`

      Value unit.

      - `const MetricUnitUsd MetricUnit = "USD"`

      - `const MetricUnitPercent MetricUnit = "PERCENT"`

      - `const MetricUnitCount MetricUnit = "COUNT"`

      - `const MetricUnitRank MetricUnit = "RANK"`

    - `ObservedAt Time`

      Observation time of the latest value.

    - `Value string`

      Latest observed value, when the series carries any points.

    - `ValueType MetricValueType`

      Whether the latest value is historical or estimated.

      - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

      - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

  - `InvestmentThesis string`

    Campaign-specific investment framing.

  - `KeyRisks []OfferingKeyRisk`

    Ordered key risks.

    - `Body string`

      Plain-text risk body.

    - `Title string`

      Risk heading.

    - `CitationIDs []string`

      Profile-local citation ids supporting the risk.

  - `Participants []OfferingParticipantResource`

    Campaign participants in display order.

    - `ID string`

      Stable identifier.

    - `DisplayOrder int64`

      Stable display position.

    - `Name string`

      Display name.

    - `Role ParticipantRole`

      Presentation role.

      - `const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"`

      - `const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"`

      - `const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"`

      - `const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"`

  - `StructureDescription string`

    Vehicle/structure framing shown before typed SPV terms exist.

  - `WhyNow string`

    Why-now framing.

### Offering Document Resource

- `type OfferingDocumentResource struct{…}`

  A campaign document's display metadata. Exactly one of `url`/`object_key`
  is set; an object key is resolved and signed elsewhere.

  - `ID string`

    Stable identifier.

  - `DisplayOrder int64`

    Stable display position.

  - `DocumentType OfferingDocumentType`

    Document kind.

    - `const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"`

    - `const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"`

    - `const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"`

    - `const OfferingDocumentTypePpm OfferingDocumentType = "PPM"`

    - `const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"`

  - `Title string`

    Display title.

  - `ObjectKey string`

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

  - `PublishedAt Time`

    Publication time, when known.

  - `Source string`

    Source publisher/provider.

  - `SourceURL string`

    Source URL.

  - `URL string`

    Externally reachable URL, when the document lives at one.

### Offering Document Type

- `type OfferingDocumentType string`

  Kind of campaign document.

  - `const OfferingDocumentTypeTearsheet OfferingDocumentType = "TEARSHEET"`

  - `const OfferingDocumentTypeKeyTerms OfferingDocumentType = "KEY_TERMS"`

  - `const OfferingDocumentTypeRiskFactors OfferingDocumentType = "RISK_FACTORS"`

  - `const OfferingDocumentTypePpm OfferingDocumentType = "PPM"`

  - `const OfferingDocumentTypeOther OfferingDocumentType = "OTHER"`

### Offering Highlight

- `type OfferingHighlight struct{…}`

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

  - `Label string`

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

  - `MetricKey string`

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

  - `Unit MetricUnit`

    Value unit.

    - `const MetricUnitUsd MetricUnit = "USD"`

    - `const MetricUnitPercent MetricUnit = "PERCENT"`

    - `const MetricUnitCount MetricUnit = "COUNT"`

    - `const MetricUnitRank MetricUnit = "RANK"`

  - `ObservedAt Time`

    Observation time of the latest value.

  - `Value string`

    Latest observed value, when the series carries any points.

  - `ValueType MetricValueType`

    Whether the latest value is historical or estimated.

    - `const MetricValueTypeHistorical MetricValueType = "HISTORICAL"`

    - `const MetricValueTypeEstimated MetricValueType = "ESTIMATED"`

### Offering Key Risk

- `type OfferingKeyRisk struct{…}`

  One ordered key-risk block.

  - `Body string`

    Plain-text risk body.

  - `Title string`

    Risk heading.

  - `CitationIDs []string`

    Profile-local citation ids supporting the risk.

### Offering Participant Resource

- `type OfferingParticipantResource struct{…}`

  An offering participant's display data.

  - `ID string`

    Stable identifier.

  - `DisplayOrder int64`

    Stable display position.

  - `Name string`

    Display name.

  - `Role ParticipantRole`

    Presentation role.

    - `const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"`

    - `const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"`

    - `const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"`

    - `const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"`

### Offering Spv

- `type OfferingSpv struct{…}`

  The attached SPV's identity and lifecycle. Exact economics surface once the
  SPV opens; an upcoming offering's indicative ranges describe the terms until
  then.

  - `ID string`

    Stable SPV identifier.

  - `Name string`

    Legal/display name.

  - `Status SpvStatus`

    Lifecycle state.

    - `const SpvStatusDraft SpvStatus = "DRAFT"`

    - `const SpvStatusOpen SpvStatus = "OPEN"`

    - `const SpvStatusClosed SpvStatus = "CLOSED"`

    - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

    - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

  - `CustodianName string`

    Custodian.

  - `ManagerName string`

    SPV manager.

  - `NdaAgreement NdaAgreementResource`

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

    - `AcceptanceText string`

      Exact assent and authority representation shown to the signer.

    - `AcceptanceTextVersion int64`

      Version of the acceptance representation.

    - `AgreementID string`

      Stable agreement identifier submitted with an IOI acceptance.

    - `DocumentReference string`

      Durable reference to the immutable NDA artifact.

    - `DocumentSha256 string`

      Lowercase SHA-256 digest of the artifact bytes.

    - `EffectiveAt Time`

      Time this version became effective.

    - `Version int64`

      Strictly increasing SPV-local agreement version.

  - `ShareClass string`

    Underlying share class, when specified.

  - `StructureDescription string`

    Plain-text vehicle structure.

### Participant Role

- `type ParticipantRole string`

  Presentation role of an offering participant.

  - `const ParticipantRoleLeadInvestor ParticipantRole = "LEAD_INVESTOR"`

  - `const ParticipantRoleCoLead ParticipantRole = "CO_LEAD"`

  - `const ParticipantRoleFundManager ParticipantRole = "FUND_MANAGER"`

  - `const ParticipantRolePlacementAgent ParticipantRole = "PLACEMENT_AGENT"`

### Spv Status

- `type SpvStatus string`

  SPV lifecycle state.

  - `const SpvStatusDraft SpvStatus = "DRAFT"`

  - `const SpvStatusOpen SpvStatus = "OPEN"`

  - `const SpvStatusClosed SpvStatus = "CLOSED"`

  - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

  - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

### Valuation Basis

- `type ValuationBasis string`

  Meaning of an indicative valuation range or an SPV valuation.

  - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

  - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

  - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

  - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

# Spvs

## Domain Types

### Charged By

- `type ChargedBy string`

  Party charging a fee.

  - `const ChargedByFundManager ChargedBy = "FUND_MANAGER"`

  - `const ChargedByClearStreet ChargedBy = "CLEAR_STREET"`

  - `const ChargedByThirdParty ChargedBy = "THIRD_PARTY"`

### Fee Frequency

- `type FeeFrequency string`

  Fee timing/cadence.

  - `const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"`

  - `const FeeFrequencyAnnual FeeFrequency = "ANNUAL"`

  - `const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"`

  - `const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"`

### Fee Type

- `type FeeType string`

  Kind of SPV fee.

  - `const FeeTypeManagement FeeType = "MANAGEMENT"`

  - `const FeeTypeCarry FeeType = "CARRY"`

  - `const FeeTypePlacement FeeType = "PLACEMENT"`

  - `const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"`

  - `const FeeTypeOther FeeType = "OTHER"`

### Spv Detail

- `type SpvDetail struct{…}`

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

  - `ID string`

    Stable SPV identifier.

  - `CompanyID string`

    Company whose shares the vehicle holds.

  - `Currency Currency`

    Terms currency.

    - `const CurrencyUsd Currency = "USD"`

  - `Name string`

    Legal/display name.

  - `Status SpvStatus`

    Lifecycle state.

    - `const SpvStatusDraft SpvStatus = "DRAFT"`

    - `const SpvStatusOpen SpvStatus = "OPEN"`

    - `const SpvStatusClosed SpvStatus = "CLOSED"`

    - `const SpvStatusLiquidating SpvStatus = "LIQUIDATING"`

    - `const SpvStatusDissolved SpvStatus = "DISSOLVED"`

  - `AllInPricePerShare string`

    Price per share including fees.

  - `CustodianName string`

    Custodian.

  - `FeePerShare string`

    Per-share fee.

  - `FeeTerms []SpvFeeTermResource`

    Typed fee schedule.

    - `ChargedBy ChargedBy`

      Charging party.

      - `const ChargedByFundManager ChargedBy = "FUND_MANAGER"`

      - `const ChargedByClearStreet ChargedBy = "CLEAR_STREET"`

      - `const ChargedByThirdParty ChargedBy = "THIRD_PARTY"`

    - `Currency Currency`

      Terms currency.

    - `Description string`

      Plain-text fee disclosure.

    - `FeeType FeeType`

      Fee kind.

      - `const FeeTypeManagement FeeType = "MANAGEMENT"`

      - `const FeeTypeCarry FeeType = "CARRY"`

      - `const FeeTypePlacement FeeType = "PLACEMENT"`

      - `const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"`

      - `const FeeTypeOther FeeType = "OTHER"`

    - `Frequency FeeFrequency`

      Timing/cadence.

      - `const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"`

      - `const FeeFrequencyAnnual FeeFrequency = "ANNUAL"`

      - `const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"`

      - `const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"`

    - `Amount string`

      Exact fixed amount, when amount-based.

    - `DurationYears string`

      Charge duration in years, when specified.

    - `HurdleRate string`

      Carry hurdle as a decimal fraction, when specified.

    - `Rate string`

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

  - `FundedPercent string`

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

  - `FundingDeadline Time`

    Funding deadline.

  - `ManagerName string`

    SPV manager.

  - `MinimumInvestmentAmount string`

    Minimum investment amount.

  - `OpenedAt Time`

    Time the vehicle opened.

  - `PricePerShare string`

    Price per share excluding fees.

  - `RemainingAllocationAmount string`

    Remaining dollar allocation.

  - `RemainingShareAllocation string`

    Remaining share allocation.

  - `ShareClass string`

    Underlying share class, when specified.

  - `StructureDescription string`

    Plain-text vehicle structure.

  - `TotalAllocationAmount string`

    Total dollar allocation.

  - `TotalShareAllocation string`

    Total share allocation.

  - `Valuation string`

    Exact company valuation.

  - `ValuationBasis ValuationBasis`

    Meaning of `valuation`.

    - `const ValuationBasisPreMoney ValuationBasis = "PRE_MONEY"`

    - `const ValuationBasisPostMoney ValuationBasis = "POST_MONEY"`

    - `const ValuationBasisReference ValuationBasis = "REFERENCE"`

    - `const ValuationBasisImplied ValuationBasis = "IMPLIED"`

### Spv Fee Term Resource

- `type SpvFeeTermResource struct{…}`

  One typed SPV fee term.

  - `ChargedBy ChargedBy`

    Charging party.

    - `const ChargedByFundManager ChargedBy = "FUND_MANAGER"`

    - `const ChargedByClearStreet ChargedBy = "CLEAR_STREET"`

    - `const ChargedByThirdParty ChargedBy = "THIRD_PARTY"`

  - `Currency Currency`

    Terms currency.

    - `const CurrencyUsd Currency = "USD"`

  - `Description string`

    Plain-text fee disclosure.

  - `FeeType FeeType`

    Fee kind.

    - `const FeeTypeManagement FeeType = "MANAGEMENT"`

    - `const FeeTypeCarry FeeType = "CARRY"`

    - `const FeeTypePlacement FeeType = "PLACEMENT"`

    - `const FeeTypeAdministrative FeeType = "ADMINISTRATIVE"`

    - `const FeeTypeOther FeeType = "OTHER"`

  - `Frequency FeeFrequency`

    Timing/cadence.

    - `const FeeFrequencyOneTime FeeFrequency = "ONE_TIME"`

    - `const FeeFrequencyAnnual FeeFrequency = "ANNUAL"`

    - `const FeeFrequencyAtExit FeeFrequency = "AT_EXIT"`

    - `const FeeFrequencyPassThrough FeeFrequency = "PASS_THROUGH"`

  - `Amount string`

    Exact fixed amount, when amount-based.

  - `DurationYears string`

    Charge duration in years, when specified.

  - `HurdleRate string`

    Carry hurdle as a decimal fraction, when specified.

  - `Rate string`

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