/green_japan/companies

POST /api/green_japan/companies

Price: 10 credits

Get one company on Green (green-japan.com): business description, highlights, address, president, founding date, headcount, average age, capital, revenue history, stock market, shareholders, main customers, industries and features, photos, its number of listed jobs, the welcome message, the company interview, PR stories, the employee survey answers, user reviews with NPS scores, articles and similar companies.

How to use it

Get the company's jobs with green_japan/companies/jobs. Company ids come from green_japan/jobs/search results.

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 id or URL (examples: "10892", "https://www.green-japan.com/company/10892")

Response

• @type string (default: "GreenJapanCompany")
• id string required
• url string required
• name string nullable
• description string nullable
• highlights array (default: [])
• address string nullable
• president_name string nullable
• founded_date integer nullable
• employee_count integer nullable
• average_age number nullable
• capital string nullable
• revenues array (default: [])
  • @type string (default: "GreenJapanRevenue")
  • year integer required
  • month integer nullable
  • amount number nullable
  • amount_text string required
• stock_market string nullable
• stock_market_id string nullable
• shareholders string nullable
• main_customers string nullable
• industries array (default: [])
  • @type string (default: "GreenJapanIndustryRef")
  • id string required
  • name string required
  • category_id string nullable
  • category_name string nullable
• features array (default: [])
• feature_ids array (default: [])
• premium_interviews array (default: [])
  • @type string (default: "GreenJapanPremiumInterview")
  • id string required
  • directory_name string nullable
• image string nullable
• cover string nullable
• images array (default: [])
• job_count integer nullable
• welcome_comment object nullable
  • @type string (default: "GreenJapanWelcomeComment")
  • author_name string nullable
  • text string required
  • image string nullable
• interview object nullable
  • @type string (default: "GreenJapanInterview")
  • image string nullable
  • image_caption string nullable
  • sections array (default: [])
    • @type string (default: "GreenJapanInterviewItem")
    • id string nullable
    • text string required
• pr_sections array (default: [])
  • @type string (default: "GreenJapanPrSection")
  • id string nullable
  • text string required
  • image string nullable
  • image_caption string nullable
• survey array (default: [])
  • @type string (default: "GreenJapanSurveyQuestion")
  • question_id string nullable
  • question string required
  • answers array (default: [])
    • @type string (default: "GreenJapanSurveyAnswer")
    • text string required
    • answered_date integer nullable
    • is_anonymous boolean nullable
    • respondent_age_range string nullable
    • respondent_hire_type string nullable
    • respondent_joined_year integer nullable
    • respondent_job_category string nullable
    • respondent_job_category_detail string nullable
• user_reviews array (default: [])
  • @type string (default: "GreenJapanUserReview")
  • id string nullable
  • text string nullable
  • nps_score integer nullable
  • job_type string nullable
  • responded_at integer nullable
• articles array (default: [])
  • @type string (default: "GreenJapanArticle")
  • id string nullable
  • text string nullable
  • images array (default: [])
    • @type string (default: "GreenJapanCaptionedImage")
    • image string required
    • caption string nullable
• similar_companies array (default: [])
  • @type string (default: "GreenJapanSimilarCompany")
  • id string required
  • url string required
  • name 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 — No company under that id 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.