/proftools/categories

POST /api/proftools/categories

Price: 10 credits

List the ProfTools (proftools.ru) catalogue sections: the root call returns every top-level section together with the sections one level below it and the number of products each holds, and a call with a section path returns that section's own child sections with their images and shop descriptions.

How to use it

Start here to learn which section paths proftools.ru accepts, then feed path into the category products endpoint. Brands live here as sections rather than as a filter, so a brand price list is a section walk. The root call already covers two levels and is the only one carrying item_count; descending further is only needed for the third and fourth levels, which the root call does not name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of sections to return (min: 1)
• category string nullable — Section path whose child sections to list; omit it for the catalogue root, which also names the sections one level below each root entry together with their item counts (examples: "elektroinstrument", "elektroinstrument/uglovye_shlifmashiny_ushm_ugloshlify_bolgarki"; minLength: 1)

Response

• @type string (default: "ProftoolsCategory")
• path string required
• url string required
• name string nullable
• parent_path string nullable
• level integer (default: 1)
• item_count integer nullable
• section_id string nullable
• image string nullable
• description 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 catalogue section is served under this path. 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.