SDK ReferencePython SDK

Search

API functions for the Search resource.

Search

Functions for interacting with the search API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Search the web

Runs a web search for query and returns ranked organic results with contiguous position values from 1.

Use limit (1–100, default 10) to request more results in a single call. Results are fetched in pages of 10, so a call consumes ceil(limit / 10) credits (capped at 10) from the account's monthly credits bucket — for example limit=10 costs 1 credit and limit=35 costs 4. Credits are charged for every page fetched regardless of how many results a page returns. The credit count is reported as credits_used in the response.

Parameters

  • body (CreateSearchBody)

Call styles

sync_detailed(client=client, body=body) -> Response[CreateSearchResponse200 | Error]
sync(client=client, body=body) -> CreateSearchResponse200 | Error | None
await asyncio_detailed(client=client, body=body) -> Response[CreateSearchResponse200 | Error]
await asyncio(client=client, body=body) -> CreateSearchResponse200 | Error | None