API

Every bigpictureio.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Company

find

company.find Find detailed company information by domain Risk: read

await corsair.bigpictureio.api.company.find({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`webhookUrl`	`string`	No	—
`webhookId`	`string`	No	—

Output: object

Output full type

{
  id?: string,
  name?: string,
  legalName?: string,
  domain?: string,
  url?: string,
  logo?: string,
  type?: string,
  phone?: string,
  ticker?: string,
  description?: string,
  foundedYear?: number,
  tags?: string[],
  tech?: string[],
  aliases?: string[],
  domainAliases?: string[],
  category?: {
    sector?: string,
    industryGroup?: string,
    industry?: string,
    subIndustry?: string,
    naicsCode?: string
  },
  metrics?: {
    raised?: number,
    employees?: number,
    marketCap?: number,
    trancoRank?: number,
    alexaUsRank?: number,
    annualRevenue?: number,
    employeesRange?: string,
    alexaGlobalRank?: number,
    estimatedAnnualRevenue?: string
  },
  location?: string,
  geo?: {
    streetNumber?: string | null,
    streetName?: string | null,
    subPremise?: string | null,
    city?: string | null,
    state?: string | null,
    postalCode?: string | null,
    stateCode?: string | null,
    country?: string | null,
    countryCode?: string | null
  },
  facebook?: {
    handle?: string
  },
  linkedin?: {
    handle?: string,
    industry?: string
  },
  twitter?: {
    id?: string,
    bio?: string,
    site?: string,
    avatar?: string,
    handle?: string,
    location?: string,
    followers?: number,
    following?: number
  },
  crunchbase?: {
    handle?: string
  },
  emailProvider?: boolean,
  indexedAt?: string
} | {
  pending: true,
  webhookUrl: string,
  webhookId?: string
}

stream

company.stream Hold the company lookup open until BigPicture finishes Risk: read

await corsair.bigpictureio.api.company.stream({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`legalName`	`string`	No	—
`domain`	`string`	No	—
`url`	`string`	No	—
`logo`	`string`	No	—
`type`	`string`	No	—
`phone`	`string`	No	—
`ticker`	`string`	No	—
`description`	`string`	No	—
`foundedYear`	`number`	No	—
`tags`	`string[]`	No	—
`tech`	`string[]`	No	—
`aliases`	`string[]`	No	—
`domainAliases`	`string[]`	No	—
`category`	`object`	No	—
`metrics`	`object`	No	—
`location`	`string`	No	—
`geo`	`object`	No	—
`facebook`	`object`	No	—
`linkedin`	`object`	No	—
`twitter`	`object`	No	—
`crunchbase`	`object`	No	—
`emailProvider`	`boolean`	No	—
`indexedAt`	`string`	No	—

category full type

{
  sector?: string,
  industryGroup?: string,
  industry?: string,
  subIndustry?: string,
  naicsCode?: string
}

metrics full type

{
  raised?: number,
  employees?: number,
  marketCap?: number,
  trancoRank?: number,
  alexaUsRank?: number,
  annualRevenue?: number,
  employeesRange?: string,
  alexaGlobalRank?: number,
  estimatedAnnualRevenue?: string
}

geo full type

{
  streetNumber?: string | null,
  streetName?: string | null,
  subPremise?: string | null,
  city?: string | null,
  state?: string | null,
  postalCode?: string | null,
  stateCode?: string | null,
  country?: string | null,
  countryCode?: string | null
}

facebook full type

{
  handle?: string
}

linkedin full type

{
  handle?: string,
  industry?: string
}

twitter full type

{
  id?: string,
  bio?: string,
  site?: string,
  avatar?: string,
  handle?: string,
  location?: string,
  followers?: number,
  following?: number
}

crunchbase full type

{
  handle?: string
}

Ip

find

ip.find Find the company associated with an IP address Risk: read

await corsair.bigpictureio.api.ip.find({});

Input

Name	Type	Required	Description
`ip`	`string`	Yes	—

Output

Name	Type	Required	Description
`ip`	`string`	Yes	—
`type`	`string`	No	—
`fuzzy`	`boolean`	No	—
`confidence`	`number`	No	—
`geo`	`object`	No	—
`company`	`object`	No	—
`whois`	`object`	No	—
`asn`	`object`	No	—

geo full type

{
  city?: string,
  state?: string,
  stateCode?: string,
  country?: string,
  countryCode?: string,
  continent?: string,
  continentCode?: string,
  isEU?: boolean
}

company full type

{
  id?: string,
  name?: string,
  legalName?: string,
  domain?: string,
  url?: string,
  logo?: string,
  type?: string,
  phone?: string,
  ticker?: string,
  description?: string,
  foundedYear?: number,
  tags?: string[],
  tech?: string[],
  aliases?: string[],
  domainAliases?: string[],
  category?: {
    sector?: string,
    industryGroup?: string,
    industry?: string,
    subIndustry?: string,
    naicsCode?: string
  },
  metrics?: {
    raised?: number,
    employees?: number,
    marketCap?: number,
    trancoRank?: number,
    alexaUsRank?: number,
    annualRevenue?: number,
    employeesRange?: string,
    alexaGlobalRank?: number,
    estimatedAnnualRevenue?: string
  },
  location?: string,
  geo?: {
    streetNumber?: string | null,
    streetName?: string | null,
    subPremise?: string | null,
    city?: string | null,
    state?: string | null,
    postalCode?: string | null,
    stateCode?: string | null,
    country?: string | null,
    countryCode?: string | null
  },
  facebook?: {
    handle?: string
  },
  linkedin?: {
    handle?: string,
    industry?: string
  },
  twitter?: {
    id?: string,
    bio?: string,
    site?: string,
    avatar?: string,
    handle?: string,
    location?: string,
    followers?: number,
    following?: number
  },
  crunchbase?: {
    handle?: string
  },
  emailProvider?: boolean,
  indexedAt?: string
}

whois full type

{
  domain?: string,
  name?: string
}

asn full type

{
  asn?: string,
  name?: string,
  route?: string
}

Overview

Plugins

Company

find

stream

Ip

find

​Company

​find

​stream

​Ip

​find

Company

find

stream

Ip

find