Skip to content
Docs

Retrieve a Yahoo search

Early access. Tell us what you're building and we'll set you up. Contact us

GETapi.lempile.com/searches/{searchId}.json

Polls or reads a Yahoo search. HTTP 202 while it is queued or running (status: Processing), HTTP 200 once it is Success or Error. Needs the search.read scope.

Authentication

X-API-KEY header·A Lempile API key, made in the dashboard under Access tokens.

Path parameters

  • searchIdstringrequired

    Search archive id returned in search_metadata.id.

    ≥ 8 chars

Query parameters

  • api_keystring

    API key with search.write for search creation routes or search.read for archive routes. X-API-KEY may be used instead.

Responses

200

The finished search.

›

application/json

  • search_metadataYahooSearchMetadatarequired
    ›Show fields
    • idstringrequired
    • statusstringrequired
      One ofProcessingSuccessError
    • status_detailstring

      On a failed search: why (yahoo_blocked, yahoo_consent_wall, yahoo_search_failed, search_queue_timeout).

    • json_endpointstring · uri
    • raw_html_filestring · uri
    • yahoo_urlstring · uri

      The Yahoo address the search opened.

    • created_atstring
    • processed_atstring
    • total_time_takennumber
  • search_parametersobjectrequired

    engine, p, yahoo_domain, device and the parameters given.

  • search_informationobject
    ›Show fields
    • query_displayedstring
    • organic_results_statestring
  • organic_resultsarray of YahooOrganicResult
    ›Show fields
    • positionintegerrequired

      1-based position on this page.

    • titlestringrequired
    • linkstring · urirequired

      The result's own address, read from Yahoo's page.

    • redirect_linkstring · uri

      Yahoo's click link for the same result, when Yahoo's page wraps it (most results have none).

    • displayed_linkstring

      The address as Yahoo shows it, parts separated by ›. Read link for the address.

    • sourcestring

      The site's name as Yahoo shows it.

    • snippetstring
  • paginationobject

    The pages Yahoo offers, with Yahoo's own addresses: current, next, previous, other_pages. For the next page, send the same search with the b of next.

  • serpapi_paginationYahooPagination
    ›Show fields
    • currentinteger
    • nextstring · uri
    • next_linkstring · uri
    • previousstring · uri
    • previous_linkstring · uri
    • other_pagesobject
  • errorstring

    On a failed search: what happened.

202

Still queued or running. Keep polling.

›

application/json

  • search_metadataSerpApiSearchMetadatarequired

    SerpApi-compatible lifecycle metadata. Internal Queued and Running states are exposed as public Processing plus detail fields.

    ›Show fields
    • idstringrequired
    • statusstringrequired
      One ofProcessingSuccessError
    • status_detailstring

      Internal state such as Queued, Running, or a final status detail.

    • runner_status_detailstring

      Runner detail such as queued, runner_claimed, lease_renewed, completed, search_queue_timeout, or runner_lease_expired.

    • json_endpointstring · uri
    • pixel_position_endpointstring · uri
    • raw_html_filestring · uri
    • created_atstring
    • queued_atstring
    • started_atstring
    • lease_expires_atstring
    • processed_atstring | null
    • total_time_takennumber | null
  • search_parametersSerpApiSearchParameters

    The search's stored parameters: engine, p, yahoo_domain, device and the parameters given.

401

Missing or invalid API key.

›

application/json

  • errorstringrequired

    SerpApi-compatible error message.

  • error_codestring

    Machine-readable Lempile error code when available.

403

The API key does not include the required search.read scope.

›

application/json

  • errorstringrequired

    SerpApi-compatible error message.

  • error_codestring

    Machine-readable Lempile error code when available.

404

Search archive id was not found for the current workspace.

›

application/json

  • errorstringrequired

    SerpApi-compatible error message.

  • error_codestring

    Machine-readable Lempile error code when available.

Was this page helpful?