/levelsfyi/companies

POST /api/levelsfyi/companies

Price: 10 credits

Get Levels.fyi (levels.fyi) company profile by alias or profile URL

How to use it

Get the Levels.fyi (levels.fyi) company profile by alias (the URL segment like 'google') or profile URL. Returns the company description, website, domains, industry, company type and funding stage, headquarters location (city, state, country), employee count and estimated revenue, the equity vesting schedule and type, the general level ladder, notable insights, and related companies.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company alias (the URL segment, e.g. 'google') or a full company profile URL (examples: "google", "microsoft", "https://www.levels.fyi/companies/google"; minLength: 1; pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$)

Response

• @type string (default: "LevelsfyiCompany")
• id integer required
• alias string required
• name string required
• url string required
• description string nullable
• short_description string nullable
• website string nullable
• career_page string nullable
• image string nullable
• cover string nullable
• ticker string nullable
• industry string nullable
• company_type string nullable
• funding_stage string nullable
• year_founded integer nullable
• emp_count integer nullable
• employee_count_range string nullable
• estimated_annual_revenue string nullable
• estimated_valuation string nullable
• pay_schedule string nullable
• hq_address string nullable
• hq_city string nullable
• hq_state string nullable
• hq_state_code string nullable
• hq_country string nullable
• hq_latitude number nullable
• hq_longitude number nullable
• linkedin string nullable
• twitter string nullable
• crunchbase string nullable
• ein string nullable
• domains array (default: [])
• general_levels array (default: [])
• vesting_type string nullable
• vesting_schedule string nullable
• vesting_detail string nullable
• updated_at string nullable
• tags array (default: [])
• aliases array (default: [])
• insights array (default: [])
  • @type string (default: "LevelsfyiCompanyInsight")
  • insight string required
  • icon string nullable
• related_companies array (default: [])
  • @type string (default: "LevelsfyiRelatedCompany")
  • name string required
  • alias string nullable
  • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Company not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.