/flamp/firms

POST /api/flamp/firms

Price: 1 credit

Get a Flamp organization (firm) by its id

How to use it

Get full Flamp organization details by firm id. Returns name, address, coordinates, contacts (phone, website, email, social links), categories (rubrics), the Flamp rating and review counts, the rating distribution by stars, recommendation and trusted-review counts, working hours, nearby metro stations, and the linked business account when present.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• firm string required — Flamp firm id (the numeric id from the firm URL flamp.ru/firm/{slug}-{id}, or the full URL) (examples: "70000001057729636"; minLength: 1)

Response

• @type string (default: "FlampFirm")
• id string required
• name string required
• alias string nullable
• name_primary string nullable
• name_extension string nullable
• address string nullable
• building_name string nullable
• city string nullable
• district string nullable
• latitude number nullable
• longitude number nullable
• rating number nullable
• review_count integer (default: 0)
• photo_count integer (default: 0)
• recommendation_count integer (default: 0)
• official_answer_review_count integer (default: 0)
• trusted_review_count integer (default: 0)
• rating_distribution object (default: {})
  • * integer
• org_id string nullable
• phone string nullable
• website string nullable
• email string nullable
• socials object (default: {})
  • * string
• primary_rubric string nullable
• rubrics array (default: [])
  • @type string (default: "FlampFirmRubric")
  • id string required
  • name string required
  • alias string nullable
  • kind string nullable
  • parent_id string nullable
  • parent_name string nullable
• work_hours array (default: [])
  • @type string (default: "FlampFirmDay")
  • day string required
  • working_hours array (default: [])
• nearest_stations array (default: [])
  • @type string (default: "FlampFirmStation")
  • id string required
  • name string nullable
  • distance integer nullable
  • line string nullable
  • types array (default: [])
• business_account object nullable
  • @type string (default: "FlampBusinessAccount")
  • id string required
  • name string nullable
  • image string nullable
  • is_premium boolean (default: false)
  • filial_count integer (default: 0)
• has_official_answers boolean (default: false)
• is_blocked boolean (default: false)
• url 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 — Firm not found for the given 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.