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.

ParametersExpand Collapse

companyID string

query V1PrivateMarketGetCompanyByIDParams

AccountID param.Field[int64]

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

formatint64

ReturnsExpand Collapse

type V1PrivateMarketGetCompanyByIDResponse struct{…}

Data CompanyDetail

A company’s identity and its complete published profile.

ID string

Stable company identifier.

formatuuid

Name string

Display name.

Profile CompanyProfileResource

The complete versioned company profile.

Categories []CompanyCategoryOptional

Company categories.

Name string

Display name.

Slug string

Stable lowercase category slug.

Citations []CompanyCitationOptional

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 TimeOptional

Source publication time, when known.

formatdate-time

Customers []CompanyCustomerOptional

Named customers evidenced by the source material.

Name string

Customer name.

LogoURL stringOptional

Customer logo, when supplied.

Documents []CompanyDocumentResourceOptional

Company-level research and source documents.

DocumentType CompanyDocumentType

Typed document kind.

One of the following:

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.

One of the following:

const CompanyDocumentRelationSubject CompanyDocumentRelation = "SUBJECT"

const CompanyDocumentRelationConnected CompanyDocumentRelation = "CONNECTED"

Title string

Display title.

URL string

Document URL.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Preview CompanyDocumentPreviewOptional

Optional card preview.

Description stringOptional

Preview description.

ImageURL stringOptional

Preview image URL.

PublishedAt TimeOptional

Publication time, when known.

formatdate-time

Headquarters CompanyHeadquartersOptional

Company headquarters, when known.

City string

City.

Country string

Country.

LegalEntities []CompanyLegalEntityOptional

Known legal entities associated with the company.

Country string

Country name or ISO country code supplied by the source.

Name string

Legal name.

MetricSeries []CompanyMetricSeriesOptional

Historical and estimated metric series.

Frequency MetricFrequency

Observation cadence.

One of the following:

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.

One of the following:

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.

One of the following:

const MetricUnitUsd MetricUnit = "USD"

const MetricUnitPercent MetricUnit = "PERCENT"

const MetricUnitCount MetricUnit = "COUNT"

const MetricUnitRank MetricUnit = "RANK"

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Points []CompanyMetricPointOptional

Ordered observations.

ObservedAt Time

Observation time.

formatdate-time

Value string

Exact decimal value, serialized as a string.

ValueType MetricValueType

Historical or estimated classification.

One of the following:

const MetricValueTypeHistorical MetricValueType = "HISTORICAL"

const MetricValueTypeEstimated MetricValueType = "ESTIMATED"

CitationIDs []stringOptional

Profile-local citation ids supporting this point.

SourceEventID stringOptional

Optional source event identifier.

SourceMetadata map[string, string]Optional

Optional provider reconciliation metadata.

SourceURL stringOptional

Source URL, when available.

NarrativeSections []CompanyNarrativeSectionOptional

Ordered durable company fact and thesis blocks.

Body string

Plain-text section body.

DisplayOrder int64

Stable display position within the profile.

formatint32

Title string

Section heading.

CitationIDs []stringOptional

Profile-local citation ids supporting this block.

Overview stringOptional

Long company overview.

People []CompanyPersonOptional

Key people and their roles.

Name string

Display name.

ExternalID stringOptional

Optional source identifier retained for reconciliation.

Roles []CompanyPersonRoleOptional

One or more curated company roles.

One of the following:

const CompanyPersonRoleFounder CompanyPersonRole = "FOUNDER"

const CompanyPersonRoleCeo CompanyPersonRole = "CEO"

const CompanyPersonRoleOther CompanyPersonRole = "OTHER"

Social/profile links.

Type CompanySocialType

Link type.

One of the following:

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 stringOptional

Short durable positioning line used with the company name.

ProfileSchemaVersion int64

Profile schema version discriminator.

formatint32

ShortDescription string

Short card/search description.

Slug string

Lowercase URL slug.

LogoURL stringOptional

Company logo URL, when known.

PrimaryDomain stringOptional

Canonical lowercase domain, when known.

PublishedAt TimeOptional

Publication time.

formatdate-time

Get Company

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

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