Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tinyfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://api.search.tinyfish.ai
All requests require an X-API-Key header. See Authentication.

​
Request

GET https://api.search.tinyfish.ai?query=web+automation+tools&location=US&language=en

​
Parameters

​
query
string
required
The search query string. Use search operators inside this string to scope results to specific sites or exclude sites. For example, python tutorial site:docs.python.org returns results from Python’s docs, while recipe ideas -site:facebook.com -site:youtube.com excludes Facebook and YouTube results.
​
location
string
Country code for geo-targeted results (e.g. US, GB, FR, DE). When omitted, auto-resolves based on language (e.g. fr → FR). Defaults to US if both location and language are omitted.
​
language
string
Language code for result language (e.g. en, fr, de). When omitted, auto-resolves based on location (e.g. FR → fr). Defaults to en if both location and language are omitted.
​
page
number
Page number for pagination, starting from 0 (e.g. 2 to retrieve the third page of results). Maximum value is 10.
Location & language auto-resolution: If only one of location or language is provided, the other is automatically resolved to the most predominant pairing. For example, setting location=BR without language resolves to language=pt. Setting language=ja without location resolves to location=JP. If neither is set, they default to US and en.

​
Response

{
  "query": "web automation tools",
  "results": [...],
  "total_results": 10
}

​
Top-level fields

​
query
string
The search query that was executed.
​
results
object[]
Array of search results.
​
total_results
number
Total number of results returned.
​
page
number
The current page number, starting from 0.

​
results[]

​
position
number
Position in search results (1-indexed).
​
site_name
string
Domain name of the result.
​
title
string
Page title.
​
snippet
string
Text snippet from the result.
​
url
string
URL of the result.

​
SDK Methods

from tinyfish import TinyFish

client = TinyFish()
response = client.search.query(query="web automation tools", location="United States")
for r in response.results:
    print(r.title, "→", r.url)

​
Error Codes

StatusMeaning
400Invalid request — missing query parameter or bad parameter value
401Missing or invalid API key
402Payment required — active subscription required
403Search API access is not enabled for this account
404Search API is not available
429Rate limit exceeded
500Internal server error
503Search service unavailable — retry with backoff

​
Rate Limits

Limits apply per API key, measured in requests per minute across all requests.
PlanRequests / minute
Free30
Pay As You Go30
Starter60
Pro120
When the limit is exceeded, the API returns HTTP 429.

​
Billing

Search does not use credits.

Search Overview

First request, success shape, and product routing

Authentication

API key setup and troubleshooting

Error Codes

Full list of API error codes