Global Search

GET /search

Global Search

cURL

curl --request GET \
  --url https://api.bunny.net/search \
  --header 'AccessKey: <api-key>'

import requests

url = "https://api.bunny.net/search"

headers = {"AccessKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/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://api.bunny.net/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bunny.net/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("AccessKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bunny.net/search")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "Query": "<string>",
  "Total": 123,
  "From": 123,
  "Size": 123,
  "SearchResults": [
    {
      "Type": "<string>",
      "Id": 123,
      "Name": "<string>"
    }
  ]
}

Authorizations

AccessKeybearer

AccessKey · string · header · required

API Access Key authorization header

Query Parameters

search · string | null

from · integer<int32> · default: 0

size · integer<int32> · default: 20

Response

200

application/json

The list of platfom-wide search results

Query · string | null

The input query for the search request

Total · integer<int32>

The total number of search results found matching the query

From · integer<int32>

The number of results skipped in the search query

Size · integer<int32>

The size of the result set

SearchResults · object[] | null

The list of search results found for the query

Show child attributes