/alternativeto/lists

POST /api/alternativeto/lists

Price: 20 credits

Get a user-curated AlternativeTo list by URL or id: title, summary, author, likes and every app on it with the curator's note.

How to use it

Read a themed collection of apps a user assembled on AlternativeTo, with the curator's note per app.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• list_id string required — AlternativeTo list URL or its numeric id (examples: "https://alternativeto.net/lists/44427/slopware/", "44427"; minLength: 1)

Response

• @type string (default: "AlternativetoList")
• id string required
• alias string nullable
• url string required
• list_title string required
• summary string nullable
• description string nullable
• list_type string nullable
• likes integer nullable
• app_count integer nullable
• author_name string nullable
• author_alias string nullable
• created_at integer nullable
• updated_at integer nullable
• apps array (default: [])
  • @type string (default: "AlternativetoListApp")
  • id string required
  • alias string required
  • name string required
  • url string required
  • tagline string nullable
  • description string nullable
  • icon string nullable
  • likes integer nullable
  • alternative_count integer nullable
  • review_count integer nullable
  • rating number nullable
  • rating_count integer nullable
  • license_cost string nullable
  • license_model string nullable
  • license object nullable
    • @type string (default: "AlternativetoLicense")
    • alias string required
    • name string nullable
    • spdx_id string nullable
    • family string nullable
    • info_url string nullable
  • pricing object nullable
    • @type string (default: "AlternativetoPricing")
    • model string nullable
    • one_time_min_price number nullable
    • one_time_max_price number nullable
    • subscription_min_price number nullable
    • subscription_max_price number nullable
  • platforms array (default: [])
    • @type string (default: "AlternativetoPlatform")
    • alias string nullable
    • name string required
    • platform_type string nullable
    • note string nullable
  • app_types array (default: [])
    • @type string (default: "AlternativetoTag")
    • alias string required
    • name string required
    • kind string nullable
    • is_subcategory boolean nullable
    • category_path array (default: [])
    • likes integer nullable
    • description string nullable
  • tags array (default: [])
    • @type string (default: "AlternativetoTag")
    • alias string required
    • name string required
    • kind string nullable
    • is_subcategory boolean nullable
    • category_path array (default: [])
    • likes integer nullable
    • description string nullable
  • company object nullable
    • @type string (default: "AlternativetoCompany")
    • id string nullable
    • name string required
    • alias string nullable
    • url string nullable
    • country_code string nullable
    • region string nullable
    • is_eu boolean nullable
    • app_count integer nullable
  • website string nullable
  • screenshots array (default: [])
  • released_at integer nullable
  • recent_view_count integer nullable
  • top_alternatives array (default: [])
    • @type string (default: "AlternativetoAppRef")
    • id string nullable
    • alias string required
    • name string required
    • url string required
    • likes integer nullable
    • icon string nullable
  • note 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 AlternativeTo list with this 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.