Get Company

PrivateMarketGetCompanyByIdResponse v1().privateMarkets().getCompanyById(, )

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.

ParametersExpand Collapse

PrivateMarketGetCompanyByIdParams params

Optional<String> companyId

long accountId

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

formatint64

ReturnsExpand Collapse

class PrivateMarketGetCompanyByIdResponse:

CompanyDetail data

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

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

Get Company

package com.clearstreet.api.example;

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

public final class Main {
    private Main() {}

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

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

{
  "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"
  }
}

Returns Examples

{
  "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"
  }
}