/incruit/companies

POST /api/incruit/companies

Price: 5 credits

Get one Incruit (incruit.com) company by number or URL: name, industry, size, groups and listing, domain, logo, address, CEO, headcount, open job, follower and view counts, average annual and monthly salary with its source, entry salary, industry salary rank, monthly headcount and hiring history, and peer companies

How to use it

Pass an id from incruit/companies/search. Salaries are in KRW.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Incruit company number or URL (examples: "1466233402", "https://lab.incruit.com/inc/1466233402"; minLength: 1)

Response

• @type string (default: "IncruitCompany")
• id string required
• url string required
• name string nullable
• industry string nullable
• size string nullable
• group_names array (default: [])
• is_top1000 boolean nullable
• is_public boolean nullable
• domain string nullable
• image string nullable
• address string nullable
• ceo string nullable
• employee_count integer nullable
• open_job_count integer nullable
• follower_count integer nullable
• view_count integer nullable
• average_annual_salary number nullable
• average_monthly_salary number nullable
• salary_source string nullable
• salary_headcount integer nullable
• entry_salary number nullable
• entry_salary_year integer nullable
• industry_salary_rank integer nullable
• salary_industry string nullable
• headcount_history array (default: [])
  • @type string (default: "IncruitMonthCount")
  • month_date integer required
  • count integer required
• hiring_history array (default: [])
  • @type string (default: "IncruitMonthCount")
  • month_date integer required
  • count integer required
• peers array (default: [])
  • @type string (default: "IncruitPeer")
  • name string nullable
  • id string nullable
  • industry string nullable
  • sales number nullable
  • employee_count integer nullable
  • open_job_count integer 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 — Incruit has no company under that number 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.