بحث الويب
نتائج بحث ويب مُجمَّعة بصيغة JSON.
GET /v1/searchيتطلّب مفتاح API صالحًا، وعضويّة نشطة، وائتمان API متاحًا.
معاملات الاستعلام
| الاسم | النوع | مطلوب | الافتراضي | الوصف |
|---|---|---|---|---|
q |
string | نعم | — | استعلام البحث. يدعم معاملات البحث في Suede (مثل site:، filetype:، "exact phrase"، -exclude). |
safe |
string | لا | on |
مستوى البحث الآمن: off أو on. والقيمة غير المعروفة تُعامَل على أنها on. |
gl |
string | لا | (تلقائي) | رمز منطقة/بلد من حرفين لترجيح النتائج (مثل us، gb، ca، de، jp). والرمز غير المدعوم يُتجاهَل (يُطبَّق افتراضي المزوّد). |
hl |
string | لا | (تلقائي) | رمز لغة من حرفين للنتائج (مثل en، es، fr، de، ja). والرمز غير المدعوم يُتجاهَل. |
time |
string | لا | any |
مرشّح الحداثة: any أو hour أو day أو week أو month أو year. |
num |
integer | لا | (افتراضي المزوّد) | عدد النتائج المطلوب. يُقصّ إلى 5–100؛ والقيمة خارج النطاق تعود إلى 20. احذفه لاستخدام افتراضي المزوّد. |
الاستجابة
{
"query": "hello world",
"results": [
{
"title": "Example Domain",
"url": "https://example.com/",
"description": "This domain is for use in illustrative examples in documents."
}
]
}
| الحقل | النوع | الوصف |
|---|---|---|
query |
string | الاستعلام الذي نُفِّذ. |
results |
array | نتائج الويب. |
results[].title |
string | عنوان النتيجة. |
results[].url |
string | عنوان URL للنتيجة. |
results[].description |
string | مقتطف / وصف النتيجة. |
أمثلة
curl -G "https://api.suede.io/v1/search" \ -H "Authorization: Bearer $SUEDE_API_KEY" \ --data-urlencode "q=site:example.com filetype:pdf annual report" \ --data-urlencode "gl=us" \ --data-urlencode "num=20"
using System.Net.Http; using var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY")); var url = "https://api.suede.io/v1/search?q=" + Uri.EscapeDataString("hello world") + "&num=20"; var json = await http.GetStringAsync(url); Console.WriteLine(json);
const params = new URLSearchParams({ q: "hello world", gl: "us", num: "20" }); const res = await fetch(`https://api.suede.io/v1/search?${params}`, { headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` }, }); const data = await res.json(); for (const r of data.results) console.log(r.title, r.url);
الفوترة
تخصم كلّ مكالمة من ائتمان API المدفوع مسبقًا. وقد ينتشر عدد نتائج كبير (num فوق 10) في عدّة عمليات جلب صفحات من
المنبع ويُفوتَر تبعًا لذلك. اقرأ رصيدك في أي وقت عبر الاستخدام.