Oxylabs Web API search

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/oxylabs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_results": 10,
  "query": "nike"
}'

curl --request POST \
  --url https://api.aisa.one/apis/v1/oxylabs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "nike"
}
'

import requests

url = "https://api.aisa.one/apis/v1/oxylabs/search"

payload = { "query": "nike" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'nike'})
};

fetch('https://api.aisa.one/apis/v1/oxylabs/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.aisa.one/apis/v1/oxylabs/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' => 'nike'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.aisa.one/apis/v1/oxylabs/search"

	payload := strings.NewReader("{\n  \"query\": \"nike\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.aisa.one/apis/v1/oxylabs/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"nike\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/oxylabs/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"nike\"\n}"

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

{
  "results": [
    {
      "metadata": {
        "position": 2
      },
      "outline": [
        "<string>"
      ],
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "state": "done",
  "metadata": {
    "request_id": "<string>",
    "timestamp": 123
  },
  "params": {
    "location": "<string>",
    "max_results": 123,
    "query": "<string>"
  },
  "related_questions": [
    {
      "question": "<string>",
      "snippet": "<string>",
      "title": "<string>"
    }
  ],
  "related_searches": [
    {
      "query": "<string>"
    }
  ],
  "status": 200
}

POST

https://api.aisa.one

apis

oxylabs

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/oxylabs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_results": 10,
  "query": "nike"
}'

curl --request POST \
  --url https://api.aisa.one/apis/v1/oxylabs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "nike"
}
'

import requests

url = "https://api.aisa.one/apis/v1/oxylabs/search"

payload = { "query": "nike" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'nike'})
};

fetch('https://api.aisa.one/apis/v1/oxylabs/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.aisa.one/apis/v1/oxylabs/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' => 'nike'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.aisa.one/apis/v1/oxylabs/search"

	payload := strings.NewReader("{\n  \"query\": \"nike\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.aisa.one/apis/v1/oxylabs/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"nike\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/oxylabs/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"nike\"\n}"

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

{
  "results": [
    {
      "metadata": {
        "position": 2
      },
      "outline": [
        "<string>"
      ],
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "state": "done",
  "metadata": {
    "request_id": "<string>",
    "timestamp": 123
  },
  "params": {
    "location": "<string>",
    "max_results": 123,
    "query": "<string>"
  },
  "related_questions": [
    {
      "question": "<string>",
      "snippet": "<string>",
      "title": "<string>"
    }
  ],
  "related_searches": [
    {
      "query": "<string>"
    }
  ],
  "status": 200
}

Request contract

Method and path: POST /apis/v1/oxylabs/search
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/oxylabs/search
Runtime facts: 330a1b946e291c58fa7755e63e8cb2a4ec60e05fb4b373af15c0723c4dc1d294

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "post_oxylabs_apis_v1_oxylabs_search",
  "method": "POST",
  "path": "/apis/v1/oxylabs/search",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "examples": {
          "default": {
            "value": {
              "max_results": 10,
              "query": "nike"
            }
          },
          "minimal": {
            "value": {
              "query": "nike"
            }
          }
        },
        "schema": {
          "additionalProperties": false,
          "properties": {
            "location": {
              "maxLength": 2,
              "minLength": 2,
              "type": "string"
            },
            "max_results": {
              "default": 10,
              "maximum": 20,
              "minimum": 1,
              "type": "integer"
            },
            "query": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "query"
          ],
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "request_formula",
    "customer_pricing": "fixed_success",
    "default_request_estimate_usd": 0.00145,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Published reference price: $0.00145 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.00145
Cost contract: request_formula
Settlement evidence source: request_snapshot

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

required

Required string length: 1 - 2048

location

string

Required string length: 2

max_results

integer

default:10

Required range: 1 <= x <= 20

Response

Successful native Web API search response.

results

object[]

required

Show child attributes

state

string

required

Allowed value: "done"

metadata

object

Show child attributes

params

object

Show child attributes

status

integer

Optional success marker; if present it must agree with the HTTP success status and state.

Overview

Models

Search & Research

Finance & Crypto

Social & Media

SEO & Web Intel

Sales & Email

Travel & Other

Media Generation

Oxylabs Web API

Oxylabs Web API search

Request contract

Cost and request rules

Authorizations

Body

Response

​Request contract

​Cost and request rules

Authorizations

Body

Response

Request contract

Cost and request rules