/twogis/places/branches

POST /api/twogis/places/branches

Price: 20 credits

List all branches of a 2GIS organization by its org id and region

How to use it

List all branches (locations) of a 2GIS organization. Provide the org id and region_id taken from a place response (a place exposes org.id and region_id). Returns the full place card for each branch.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• org string required — 2GIS organization id (the org.id field of a place response) (examples: "4504136498310300"; minLength: 1)
• region_id string required — 2GIS region id of the organization (the region_id field of a place response; 32 = Moscow) (examples: "32"; minLength: 1)
• count integer required — Max number of branches to return (min: 1)

Response

• @type string (default: "TwogisPlace")
• id string required
• name string required
• type string nullable
• address string nullable
• address_comment string nullable
• latitude number nullable
• longitude number nullable
• region_id integer nullable
• city string nullable
• district string nullable
• rating number nullable
• review_count integer nullable
• rating_count integer nullable
• org_rating number nullable
• org_review_count integer nullable
• provider_ratings array (default: [])
  • @type string (default: "TwogisProviderRating")
  • tag string required
  • rating number nullable
  • review_count integer nullable
• phone string nullable
• website string nullable
• email string nullable
• socials object (default: {})
  • * string
• ad_text string nullable
• schedule array (default: [])
  • @type string (default: "TwogisScheduleDay")
  • day string required
  • working_hours array (default: [])
• rubrics array (default: [])
  • @type string (default: "TwogisRubric")
  • id string required
  • name string required
  • alias string nullable
  • kind string nullable
  • parent_id string nullable
• primary_rubric string nullable
• attributes array (default: [])
  • @type string (default: "TwogisAttribute")
  • name string required
  • tag string nullable
• org object nullable
  • @type string (default: "TwogisOrg")
  • id string required
  • name string nullable
  • branch_count integer nullable
• nearest_metro array (default: [])
  • @type string (default: "TwogisNearbyStation")
  • id string required
  • distance integer nullable
• nearest_stations array (default: [])
  • @type string (default: "TwogisNearbyStation")
  • id string required
  • distance integer nullable
• nearest_parking array (default: [])
  • @type string (default: "TwogisNearbyStation")
  • id string required
  • distance integer nullable
• has_photos boolean (default: false)
• created_at string nullable
• updated_at string nullable
• 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 — Organization not found in the given region 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.