API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Private Markets

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

Get SPV

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

GET/v1/private-markets/spvs/{spv_id}

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

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

GET/v1/private-markets/iois

Create an IOI for a visible upcoming offering.

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

POST/v1/private-markets/iois

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}

Withdraw a live IOI. Repeating a withdrawal returns 404.

v1().privateMarkets().deleteIoi(PrivateMarketDeleteIoiParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/private-markets/iois/{ioi_id}

Get Company

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

GET/v1/private-markets/companies/{company_id}

Private MarketsCompanies

ModelsExpand Collapse

class CompanyCategory:

A company category.

String name

Display name.

String slug

Stable lowercase category slug.

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.

formatdate-time

class CompanyCustomer:

A named company customer.

String name

Customer name.

Optional<String> logoUrl

Customer logo, when supplied.

class CompanyDetail:

A company’s identity and its complete published profile.

String id

Stable company identifier.

formatuuid

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.

formatdate-time

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.

One of the following:

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.

One of the following:

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.

formatdate-time

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.

One of the following:

YEAR("YEAR")

QUARTER("QUARTER")

MONTH("MONTH")

POINT_IN_TIME("POINT_IN_TIME")

String label

Display label.

MetricKey metricKey

Canonical metric key.

One of the following:

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.

One of the following:

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.

formatdate-time

String value

Exact decimal value, serialized as a string.

MetricValueType valueType

Historical or estimated classification.

One of the following:

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.

formatint32

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.

One of the following:

FOUNDER("FOUNDER")

CEO("CEO")

OTHER("OTHER")

Optional<List<CompanySocialLink>> social

Social/profile links.

CompanySocialType type

Link type.

One of the following:

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.

formatint32

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.

formatdate-time

class CompanyDocumentPreview:

Optional document card preview.

Optional<String> description

Preview description.

Optional<String> imageUrl

Preview image URL.

enum CompanyDocumentRelation:

How a document relates to the company.

SUBJECT("SUBJECT")

CONNECTED("CONNECTED")

class CompanyDocumentResource:

A company-level research or source document.

CompanyDocumentType documentType

Typed document kind.

One of the following:

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.

One of the following:

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.

formatdate-time

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")

class CompanyHeadquarters:

Company headquarters.

String city

City.

String country

Country.

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.

class CompanyMetricPoint:

One metric observation.

LocalDateTime observedAt

Observation time.

formatdate-time

String value

Exact decimal value, serialized as a string.

MetricValueType valueType

Historical or estimated classification.

One of the following:

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.

class CompanyMetricSeries:

A historical or estimated company metric series.

MetricFrequency frequency

Observation cadence.

One of the following:

YEAR("YEAR")

QUARTER("QUARTER")

MONTH("MONTH")

POINT_IN_TIME("POINT_IN_TIME")

String label

Display label.

MetricKey metricKey

Canonical metric key.

One of the following:

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.

One of the following:

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.

formatdate-time

String value

Exact decimal value, serialized as a string.

MetricValueType valueType

Historical or estimated classification.

One of the following:

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.

class CompanyNarrativeSection:

One ordered durable narrative block.

String body

Plain-text section body.

long displayOrder

Stable display position within the profile.

formatint32

String title

Section heading.

Optional<List<String>> citationIds

Profile-local citation ids supporting this block.

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.

One of the following:

FOUNDER("FOUNDER")

CEO("CEO")

OTHER("OTHER")

enum CompanyPersonRole:

A key person’s relationship to the company.

FOUNDER("FOUNDER")

CEO("CEO")

OTHER("OTHER")

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.

formatdate-time

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.

One of the following:

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.

One of the following:

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.

formatdate-time

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.

One of the following:

YEAR("YEAR")

QUARTER("QUARTER")

MONTH("MONTH")

POINT_IN_TIME("POINT_IN_TIME")

String label

Display label.

MetricKey metricKey

Canonical metric key.

One of the following:

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.

One of the following:

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.

formatdate-time

String value

Exact decimal value, serialized as a string.

MetricValueType valueType

Historical or estimated classification.

One of the following:

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.

formatint32

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.

One of the following:

FOUNDER("FOUNDER")

CEO("CEO")

OTHER("OTHER")

Optional<List<CompanySocialLink>> social

Social/profile links.

CompanySocialType type

Link type.

One of the following:

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.

class CompanySocialLink:

A company social/profile link.

CompanySocialType type

Link type.

One of the following:

WEBSITE("WEBSITE")

LINKEDIN("LINKEDIN")

X("X")

FACEBOOK("FACEBOOK")

OTHER("OTHER")

String url

Link URL.

enum CompanySocialType:

Kind of company social/profile link.

WEBSITE("WEBSITE")

LINKEDIN("LINKEDIN")

X("X")

FACEBOOK("FACEBOOK")

OTHER("OTHER")

enum MetricFrequency:

Observation cadence for a metric series.

YEAR("YEAR")

QUARTER("QUARTER")

MONTH("MONTH")

POINT_IN_TIME("POINT_IN_TIME")

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")

Private MarketsIois

ModelsExpand Collapse

class IoiCompanyResource:

Company identity embedded in an IOI list item.

String id

String name

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

class IoiOfferingResource:

Offering identity embedded in an IOI list item.

String id

String headline

class IoiResource:

One live indication of interest.

String id

long accountId

LocalDateTime createdAt

Currency currency

Terms currency.

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

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

Private MarketsOfferings

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

List Offerings

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

GET/v1/private-markets/offerings

Get Offering

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

GET/v1/private-markets/offerings/{offering_id}

ModelsExpand Collapse

enum Currency:

Terms currency.

USD("USD")

enum MetricUnit:

Unit for a resolved highlight metric.

USD("USD")

PERCENT("PERCENT")

COUNT("COUNT")

RANK("RANK")

enum MetricValueType:

Whether a resolved highlight value is observed or estimated.

HISTORICAL("HISTORICAL")

ESTIMATED("ESTIMATED")

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.

formatint32

String agreementId

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

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.

formatdate-time

long version

Strictly increasing SPV-local agreement version.

formatint32

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.

formatuuid

OfferingClass class_

Derived classification.

One of the following:

UPCOMING("UPCOMING")

ACTIVE("ACTIVE")

OfferingCompany company

Owning company identity.

String id

Stable company identifier.

formatuuid

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.

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.

One of the following:

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.

formatdate-time

Optional<String> minimumIoiAmount

Minimum indication-of-interest amount.

Optional<OfferingSpv> spv

Attached SPV identity and lifecycle, once one exists.

String id

Stable SPV identifier.

formatuuid

String name

Legal/display name.

SpvStatus status

Lifecycle state.

One of the following:

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.

formatint32

String agreementId

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

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.

formatdate-time

long version

Strictly increasing SPV-local agreement version.

formatint32

Optional<String> shareClass

Underlying share class, when specified.

Optional<String> structureDescription

Plain-text vehicle structure.

enum OfferingClass:

Derived offering classification.

UPCOMING("UPCOMING")

ACTIVE("ACTIVE")

class OfferingCompany:

Company identity carried on an offering card/detail.

String id

Stable company identifier.

formatuuid

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.

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.

formatuuid

long displayOrder

Stable display position.

formatint32

OfferingDocumentType documentType

Document kind.

One of the following:

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.

formatdate-time

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.

One of the following:

USD("USD")

PERCENT("PERCENT")

COUNT("COUNT")

RANK("RANK")

Optional<LocalDateTime> observedAt

Observation time of the latest value.

formatdate-time

Optional<String> value

Latest observed value, when the series carries any points.

Optional<MetricValueType> valueType

Whether the latest value is historical or estimated.

One of the following:

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.

formatuuid

long displayOrder

Stable display position.

formatint32

String name

Display name.

ParticipantRole role

Presentation role.

One of the following:

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.

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.

formatuuid

long displayOrder

Stable display position.

formatint32

OfferingDocumentType documentType

Document kind.

One of the following:

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.

formatdate-time

Optional<String> source

Source publisher/provider.

Optional<String> sourceUrl

Source URL.

Optional<String> url

Externally reachable URL, when the document lives at one.

enum OfferingDocumentType:

Kind of campaign document.

TEARSHEET("TEARSHEET")

KEY_TERMS("KEY_TERMS")

RISK_FACTORS("RISK_FACTORS")

PPM("PPM")

OTHER("OTHER")

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.

One of the following:

USD("USD")

PERCENT("PERCENT")

COUNT("COUNT")

RANK("RANK")

Optional<LocalDateTime> observedAt

Observation time of the latest value.

formatdate-time

Optional<String> value

Latest observed value, when the series carries any points.

Optional<MetricValueType> valueType

Whether the latest value is historical or estimated.

One of the following:

HISTORICAL("HISTORICAL")

ESTIMATED("ESTIMATED")

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.

class OfferingParticipantResource:

An offering participant’s display data.

String id

Stable identifier.

formatuuid

long displayOrder

Stable display position.

formatint32

String name

Display name.

ParticipantRole role

Presentation role.

One of the following:

LEAD_INVESTOR("LEAD_INVESTOR")

CO_LEAD("CO_LEAD")

FUND_MANAGER("FUND_MANAGER")

PLACEMENT_AGENT("PLACEMENT_AGENT")

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.

formatuuid

String name

Legal/display name.

SpvStatus status

Lifecycle state.

One of the following:

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.

formatint32

String agreementId

Stable agreement identifier submitted with an IOI acceptance.

formatuuid

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.

formatdate-time

long version

Strictly increasing SPV-local agreement version.

formatint32

Optional<String> shareClass

Underlying share class, when specified.

Optional<String> structureDescription

Plain-text vehicle structure.

enum ParticipantRole:

Presentation role of an offering participant.

LEAD_INVESTOR("LEAD_INVESTOR")

CO_LEAD("CO_LEAD")

FUND_MANAGER("FUND_MANAGER")

PLACEMENT_AGENT("PLACEMENT_AGENT")

enum SpvStatus:

SPV lifecycle state.

DRAFT("DRAFT")

OPEN("OPEN")

CLOSED("CLOSED")

LIQUIDATING("LIQUIDATING")

DISSOLVED("DISSOLVED")

enum ValuationBasis:

Meaning of an indicative valuation range or an SPV valuation.

PRE_MONEY("PRE_MONEY")

POST_MONEY("POST_MONEY")

REFERENCE("REFERENCE")

IMPLIED("IMPLIED")

Private MarketsSpvs

ModelsExpand Collapse

enum ChargedBy:

Party charging a fee.

FUND_MANAGER("FUND_MANAGER")

CLEAR_STREET("CLEAR_STREET")

THIRD_PARTY("THIRD_PARTY")

enum FeeFrequency:

Fee timing/cadence.

ONE_TIME("ONE_TIME")

ANNUAL("ANNUAL")

AT_EXIT("AT_EXIT")

PASS_THROUGH("PASS_THROUGH")

enum FeeType:

Kind of SPV fee.

MANAGEMENT("MANAGEMENT")

CARRY("CARRY")

PLACEMENT("PLACEMENT")

ADMINISTRATIVE("ADMINISTRATIVE")

OTHER("OTHER")

class SpvDetail:

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

String id

Stable SPV identifier.

formatuuid

String companyId

Company whose shares the vehicle holds.

formatuuid

Currency currency

Terms currency.

String name

Legal/display name.

SpvStatus status

Lifecycle state.

One of the following:

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.

One of the following:

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.

One of the following:

MANAGEMENT("MANAGEMENT")

CARRY("CARRY")

PLACEMENT("PLACEMENT")

ADMINISTRATIVE("ADMINISTRATIVE")

OTHER("OTHER")

FeeFrequency frequency

Timing/cadence.

One of the following:

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.

formatdate-time

Optional<String> managerName

SPV manager.

Optional<String> minimumInvestmentAmount

Minimum investment amount.

Optional<LocalDateTime> openedAt

Time the vehicle opened.

formatdate-time

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.

One of the following:

PRE_MONEY("PRE_MONEY")

POST_MONEY("POST_MONEY")

REFERENCE("REFERENCE")

IMPLIED("IMPLIED")

class SpvFeeTermResource:

One typed SPV fee term.

ChargedBy chargedBy

Charging party.

One of the following:

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.

One of the following:

MANAGEMENT("MANAGEMENT")

CARRY("CARRY")

PLACEMENT("PLACEMENT")

ADMINISTRATIVE("ADMINISTRATIVE")

OTHER("OTHER")

FeeFrequency frequency

Timing/cadence.

One of the following:

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.