/softwaresuggest/categories/products

POST /api/softwaresuggest/categories/products

Price: 20 credits

List the software products SoftwareSuggest ranks in a category for one country, in ranking order: name, tagline, logo, average rating, review count and whether it is a local product.

How to use it

See which products lead a software category in a given country. Category aliases come from softwaresuggest/categories; feed alias into softwaresuggest/products for a profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — SoftwareSuggest category URL or its alias (examples: "https://www.softwaresuggest.com/hr-software/us", "hr-software"; minLength: 1)
• country string required — Two-letter country code of the ranking (examples: "us", "gb"; pattern: ^[a-z]{2}$)
• count integer required — Max number of products to return (min: 1; max: 250)

Response

• @type string (default: "SoftwaresuggestCategoryProduct")
• alias string required
• name string required
• url string required
• position integer nullable
• subtitle string nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• location string nullable
• is_local boolean nullable
• is_premium boolean nullable
• category_alias string required
• country string required

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 SoftwareSuggest ranking for this category and country 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.