Retrieve a Yahoo search
Early access. Tell us what you're building and we'll set you up. Contact us
api.lempile.com/searches/{searchId}.jsonPolls 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
searchIdstringrequiredSearch archive id returned in
search_metadata.id.≥ 8 chars
Query parameters
api_keystringAPI key with
search.writefor search creation routes orsearch.readfor archive routes.X-API-KEYmay be used instead.
Responses
200The finished search.
›
application/json
search_metadataYahooSearchMetadatarequired›Show fieldsHide fields
idstringrequiredstatusstringrequiredOne ofProcessingSuccessErrorstatus_detailstringOn a failed search: why (
yahoo_blocked,yahoo_consent_wall,yahoo_search_failed,search_queue_timeout).json_endpointstring · uriraw_html_filestring · uriyahoo_urlstring · uriThe Yahoo address the search opened.
created_atstringprocessed_atstringtotal_time_takennumber
search_parametersobjectrequiredengine, p, yahoo_domain, device and the parameters given.
search_informationobject›Show fieldsHide fields
query_displayedstringorganic_results_statestring
organic_resultsarray of YahooOrganicResult›Show fieldsHide fields
positionintegerrequired1-based position on this page.
titlestringrequiredlinkstring · urirequiredThe result's own address, read from Yahoo's page.
redirect_linkstring · uriYahoo's click link for the same result, when Yahoo's page wraps it (most results have none).
displayed_linkstringThe address as Yahoo shows it, parts separated by ›. Read
linkfor the address.sourcestringThe site's name as Yahoo shows it.
snippetstring
paginationobjectThe 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 fieldsHide fields
currentintegernextstring · urinext_linkstring · uripreviousstring · uriprevious_linkstring · uriother_pagesobject
errorstringOn a failed search: what happened.
202Still queued or running. Keep polling.
›
application/json
search_metadataSerpApiSearchMetadatarequiredSerpApi-compatible lifecycle metadata. Internal
QueuedandRunningstates are exposed as publicProcessingplus detail fields.›Show fieldsHide fields
idstringrequiredstatusstringrequiredOne ofProcessingSuccessErrorstatus_detailstringInternal state such as
Queued,Running, or a final status detail.runner_status_detailstringRunner detail such as
queued,runner_claimed,lease_renewed,completed,search_queue_timeout, orrunner_lease_expired.json_endpointstring · uripixel_position_endpointstring · uriraw_html_filestring · uricreated_atstringqueued_atstringstarted_atstringlease_expires_atstringprocessed_atstring | nulltotal_time_takennumber | null
search_parametersSerpApiSearchParametersThe search's stored parameters: engine, p, yahoo_domain, device and the parameters given.
401Missing or invalid API key.
›
application/json
errorstringrequiredSerpApi-compatible error message.
error_codestringMachine-readable Lempile error code when available.
403The API key does not include the required search.read scope.
›
search.read scope.application/json
errorstringrequiredSerpApi-compatible error message.
error_codestringMachine-readable Lempile error code when available.
404Search archive id was not found for the current workspace.
›
application/json
errorstringrequiredSerpApi-compatible error message.
error_codestringMachine-readable Lempile error code when available.
Was this page helpful?