Web Search API
Search the web and get structured results (titles, URLs, snippets). DuckDuckGo-backed — no browser, no CAPTCHA, fast.
How to call it
Send one POST to api.upapi.io/web-search.post with your key in the X-Api-Key header and the parameters below as a JSON body. Each call spends 1 weighted unit of your monthly quota. The operation times out after 30 seconds. Identical requests are served from cache for 300 seconds, unbilled.
POST https://api.upapi.io/web-search.post
Web Search API reference
Request parameters
- query
- stringrequired — Search query
- region
- string — Region code (wt-wt=global, us-en, uk-en, etc)
- maxResults
- integer — Max results to return
Response fields
- query
- stringrequired
- message
- stringrequired
- results
- arrayrequired
- results[].url
- stringrequired
- results[].title
- stringrequired
- results[].domain
- stringrequired
- results[].snippet
- stringrequired
- results[].position
- integerrequired
- success
- booleanrequired
- elapsedMs
- integerrequired
- fetchedAt
- stringrequired
- totalResults
- integerrequired
Example request and response
The example response is generated from this operation’s published output schema — it shows the shape and field names, not values from a recorded call.
{
"query": "typescript",
"region": "wt-wt",
"maxResults": 20
}{
"query": "typescript",
"message": "example",
"results": [
{
"url": "https://github.com",
"title": "Alan Turing",
"domain": "example",
"snippet": "example",
"position": 1
}
],
"success": false,
"elapsedMs": 1,
"fetchedAt": "example",
"totalResults": 1
}Code snippets
cURL
curl -X POST https://api.upapi.io/web-search.post \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-d '{ "query": "typescript", "region": "wt-wt", "maxResults": 20 }'JavaScript
const response = await fetch('https://api.upapi.io/web-search.post', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
body: JSON.stringify({
"query": "typescript",
"region": "wt-wt",
"maxResults": 20
}),
});
const data = await response.json();
console.log(data);Python
import requests
response = requests.post(
'https://api.upapi.io/web-search.post',
headers={
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
json={
"query": "typescript",
"region": "wt-wt",
"maxResults": 20
},
)
print(response.json())Go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{ "query": "typescript", "region": "wt-wt", "maxResults": 20 }`)
req, _ := http.NewRequest("POST", "https://api.upapi.io/web-search.post", bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var result map[string]any
json.Unmarshal(body, &result)
fmt.Println(result)
}PHP
<?php
$payload = json_encode([
'query' => 'typescript',
'region' => 'wt-wt',
'maxResults' => 20,
]);
$ch = curl_init('https://api.upapi.io/web-search.post');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-api-key: YOUR_API_KEY',
],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
var_dump($data);Ruby
require 'net/http'
require 'uri'
require 'json'
uri = URI('https://api.upapi.io/web-search.post')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Post.new(uri.path)
request['Content-Type'] = 'application/json'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = { "query": "typescript", "region": "wt-wt", "maxResults": 20 }.to_json
response = http.request(request)
puts JSON.parse(response.body)Java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
OkHttpClient client = new OkHttpClient();
ObjectMapper mapper = new ObjectMapper();
String json = "{ \"query\": \"typescript\", \"region\": \"wt-wt\", \"maxResults\": 20 }";
RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
Request request = new Request.Builder()
.url("https://api.upapi.io/web-search.post")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("x-api-key", "YOUR_API_KEY")
.build();
try (Response response = client.newCall(request).execute()) {
Map<?, ?> result = mapper.readValue(response.body().string(), Map.class);
System.out.println(result);
}C#
using System.Net.Http;
using System.Net.Http.Json;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var payload = JsonSerializer.Deserialize<object>("{ \"query\": \"typescript\", \"region\": \"wt-wt\", \"maxResults\": 20 }");
var response = await client.PostAsJsonAsync("https://api.upapi.io/web-search.post", payload);
var result = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(result);Frequently asked questions
How much does the Web Search API cost per call?
Each call spends 1 weighted unit of your plan's monthly quota. Full pricing is at https://upapi.io/pricing.
How do I authenticate to the Web Search API?
Send your key in the X-Api-Key header. A free guest key is available without creating an account.
Are Web Search API responses cached?
Yes — identical requests are served from cache for 300 seconds, and a cache hit is not billed.