/habr/articles/search

POST /api/habr/articles/search

Price: 5 credits

Search Habr Articles

How to use it

Search and list Habr articles or news. Filter by keyword, hub, company, or author; order by date or rating over a period. Returns title, lead, tags, stats, author, and hubs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• lang string — Content language (default: "ru"; one of: "ru", "en")
• query string nullable — Search keyword (examples: "python")
• hub string nullable — Filter by hub alias (examples: "python")
• company string nullable — Filter by company alias (examples: "ruvds")
• user string nullable — Filter by author alias (examples: "denis-19")
• news boolean — Return news posts instead of articles (default: false)
• sort string — Result ordering (default: "date"; one of: "date", "rating")
• period string — Time window when sort is rating (default: "daily"; one of: "daily", "weekly", "monthly", "yearly", "alltime")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "HabrArticleRef")
• id string required
• lead string nullable
• url string nullable
• image string nullable
• post_type string nullable
• lang string nullable
• complexity string nullable
• reading_time integer nullable
• is_corporative boolean (default: false)
• tags array (default: [])
• published_at string nullable
• author object nullable
  • @type string (default: "HabrAuthor")
  • id string required
  • alias string required
  • fullname string nullable
  • speciality string nullable
  • image string nullable
  • rating number nullable
  • score integer nullable
• statistics object nullable
  • @type string (default: "HabrArticleStatistics")
  • comment_count integer nullable
  • favorite_count integer nullable
  • reading_count integer nullable
  • score integer nullable
  • vote_count integer nullable
  • vote_count_plus integer nullable
  • vote_count_minus integer nullable
  • reach integer nullable
  • reader_count integer nullable
• hubs array (default: [])
  • @type string (default: "HabrHubRef")
  • id string required
  • alias string required
• flows array (default: [])
  • @type string (default: "HabrFlowRef")
  • id string required
  • alias 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 — The entity was not found, or a precondition failed 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.