Search web pages, images, or news and optionally crawl source pages
curl --request POST \
--url https://bulkgrid.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"type": "web",
"limit": 10,
"country": "us",
"language": "en",
"location": "<string>",
"crawl": false,
"crawlOptions": {
"formats": [
"markdown",
"cleanHtml"
],
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"waitAfterLoad": 0,
"timeout": 30000,
"blockAds": true,
"useInteractions": false,
"waitForSelector": "<string>",
"waitForImages": false,
"removeConsentPopups": true,
"useHttp": true,
"useLlmsTxt": true
}
}
'import requests
url = "https://bulkgrid.com/api/v1/search"
payload = {
"query": "<string>",
"type": "web",
"limit": 10,
"country": "us",
"language": "en",
"location": "<string>",
"crawl": False,
"crawlOptions": {
"formats": ["markdown", "cleanHtml"],
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"waitAfterLoad": 0,
"timeout": 30000,
"blockAds": True,
"useInteractions": False,
"waitForSelector": "<string>",
"waitForImages": False,
"removeConsentPopups": True,
"useHttp": True,
"useLlmsTxt": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
type: 'web',
limit: 10,
country: 'us',
language: 'en',
location: '<string>',
crawl: false,
crawlOptions: {
formats: ['markdown', 'cleanHtml'],
includeTags: ['<string>'],
excludeTags: ['<string>'],
waitAfterLoad: 0,
timeout: 30000,
blockAds: true,
useInteractions: false,
waitForSelector: '<string>',
waitForImages: false,
removeConsentPopups: true,
useHttp: true,
useLlmsTxt: true
}
})
};
fetch('https://bulkgrid.com/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://bulkgrid.com/api/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'type' => 'web',
'limit' => 10,
'country' => 'us',
'language' => 'en',
'location' => '<string>',
'crawl' => false,
'crawlOptions' => [
'formats' => [
'markdown',
'cleanHtml'
],
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'waitAfterLoad' => 0,
'timeout' => 30000,
'blockAds' => true,
'useInteractions' => false,
'waitForSelector' => '<string>',
'waitForImages' => false,
'removeConsentPopups' => true,
'useHttp' => true,
'useLlmsTxt' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bulkgrid.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://bulkgrid.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"count": 4503599627370495,
"type": "web",
"results": [
{
"url": "<string>",
"title": "<string>",
"snippet": "<string>",
"position": 4503599627370495
}
],
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending"
},
"warnings": [
"<string>"
]
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Search
Search web pages, images, or news and optionally crawl source pages
Required permission: search:query (also runs:write when crawl is true).
POST
/
api
/
v1
/
search
Search web pages, images, or news and optionally crawl source pages
curl --request POST \
--url https://bulkgrid.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"type": "web",
"limit": 10,
"country": "us",
"language": "en",
"location": "<string>",
"crawl": false,
"crawlOptions": {
"formats": [
"markdown",
"cleanHtml"
],
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"waitAfterLoad": 0,
"timeout": 30000,
"blockAds": true,
"useInteractions": false,
"waitForSelector": "<string>",
"waitForImages": false,
"removeConsentPopups": true,
"useHttp": true,
"useLlmsTxt": true
}
}
'import requests
url = "https://bulkgrid.com/api/v1/search"
payload = {
"query": "<string>",
"type": "web",
"limit": 10,
"country": "us",
"language": "en",
"location": "<string>",
"crawl": False,
"crawlOptions": {
"formats": ["markdown", "cleanHtml"],
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"waitAfterLoad": 0,
"timeout": 30000,
"blockAds": True,
"useInteractions": False,
"waitForSelector": "<string>",
"waitForImages": False,
"removeConsentPopups": True,
"useHttp": True,
"useLlmsTxt": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
type: 'web',
limit: 10,
country: 'us',
language: 'en',
location: '<string>',
crawl: false,
crawlOptions: {
formats: ['markdown', 'cleanHtml'],
includeTags: ['<string>'],
excludeTags: ['<string>'],
waitAfterLoad: 0,
timeout: 30000,
blockAds: true,
useInteractions: false,
waitForSelector: '<string>',
waitForImages: false,
removeConsentPopups: true,
useHttp: true,
useLlmsTxt: true
}
})
};
fetch('https://bulkgrid.com/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://bulkgrid.com/api/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'type' => 'web',
'limit' => 10,
'country' => 'us',
'language' => 'en',
'location' => '<string>',
'crawl' => false,
'crawlOptions' => [
'formats' => [
'markdown',
'cleanHtml'
],
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'waitAfterLoad' => 0,
'timeout' => 30000,
'blockAds' => true,
'useInteractions' => false,
'waitForSelector' => '<string>',
'waitForImages' => false,
'removeConsentPopups' => true,
'useHttp' => true,
'useLlmsTxt' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bulkgrid.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://bulkgrid.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"type\": \"web\",\n \"limit\": 10,\n \"country\": \"us\",\n \"language\": \"en\",\n \"location\": \"<string>\",\n \"crawl\": false,\n \"crawlOptions\": {\n \"formats\": [\n \"markdown\",\n \"cleanHtml\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"waitAfterLoad\": 0,\n \"timeout\": 30000,\n \"blockAds\": true,\n \"useInteractions\": false,\n \"waitForSelector\": \"<string>\",\n \"waitForImages\": false,\n \"removeConsentPopups\": true,\n \"useHttp\": true,\n \"useLlmsTxt\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"count": 4503599627370495,
"type": "web",
"results": [
{
"url": "<string>",
"title": "<string>",
"snippet": "<string>",
"position": 4503599627370495
}
],
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending"
},
"warnings": [
"<string>"
]
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Authorizations
apiKeyAuthbearerAuth
Bulkgrid API key
Body
application/json
Required string length:
1 - 500Available options:
web, images, news Required range:
1 <= x <= 10Pattern:
^[a-z]{2}$Pattern:
^[a-z]{2,3}(?:-[A-Za-z]{2,4})?$Required string length:
1 - 200Show child attributes
Show child attributes
Response
Successful response