v1

latestOpenAPI 3.1.0License and Price2026-07-1722542.4 KB

Fetch results from internal live search

Initiates the search; will return status and search Id on success. Status = 2 means end of search result. Good manners is to wait 1s before each new result fetch.

Depending on the format parameter the response uses the text field, the records field, or both. Text is HTML encoded and intended for direct visualization to the end-user. Use format=1 for machine processing.

The response uses the following JSON structure. The status indicates whether results are available and whether the client shall continue to fetch for results.

Status

  • 0 means there are results in the response,
  • 1 means there is currently no result in the response, but the client should continue to fetch for results.
  • 2 (Terminated) and
  • 3 (Search ID Not Found) tell the client to stop querying for results. Note that with status 2 there might be the last results in the response.
get/live/search/result

Query parameters

idstring required

Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

format0 | 1 | 2

Return only specified fields: 0 = Text only, default 1 = Records only 2 = Return both fields

limitinteger

Result limit

Response

Success search

status0 | 1 | 2

Result status 0,1 - there is another result/s to fetch 2 - no more results

resultsstring

Text response