Estimate keyword volume

curl --request POST \
  --url https://app.octolens.com/api/v2/keywords/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "candidates": [
    {
      "keyword": "<string>",
      "additionalTerms": "<string>",
      "additionalTermsAndOr": true,
      "excludeWords": "<string>"
    }
  ]
}
'

import requests

url = "https://app.octolens.com/api/v2/keywords/estimate"

payload = { "candidates": [
        {
            "keyword": "<string>",
            "additionalTerms": "<string>",
            "additionalTermsAndOr": True,
            "excludeWords": "<string>"
        }
    ] }
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({
    candidates: [
      {
        keyword: '<string>',
        additionalTerms: '<string>',
        additionalTermsAndOr: true,
        excludeWords: '<string>'
      }
    ]
  })
};

fetch('https://app.octolens.com/api/v2/keywords/estimate', 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://app.octolens.com/api/v2/keywords/estimate",
  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([
    'candidates' => [
        [
                'keyword' => '<string>',
                'additionalTerms' => '<string>',
                'additionalTermsAndOr' => true,
                'excludeWords' => '<string>'
        ]
    ]
  ]),
  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://app.octolens.com/api/v2/keywords/estimate"

	payload := strings.NewReader("{\n  \"candidates\": [\n    {\n      \"keyword\": \"<string>\",\n      \"additionalTerms\": \"<string>\",\n      \"additionalTermsAndOr\": true,\n      \"excludeWords\": \"<string>\"\n    }\n  ]\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://app.octolens.com/api/v2/keywords/estimate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"candidates\": [\n    {\n      \"keyword\": \"<string>\",\n      \"additionalTerms\": \"<string>\",\n      \"additionalTermsAndOr\": true,\n      \"excludeWords\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/keywords/estimate")

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  \"candidates\": [\n    {\n      \"keyword\": \"<string>\",\n      \"additionalTerms\": \"<string>\",\n      \"additionalTermsAndOr\": true,\n      \"excludeWords\": \"<string>\"\n    }\n  ]\n}"

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

{
  "estimates": [
    {
      "keyword": "<string>",
      "volume": {
        "low": 4503599627370495,
        "high": 4503599627370495,
        "band": "quiet",
        "basis": "analog",
        "window": "30d",
        "openEnded": true,
        "perSource": [
          {
            "source": "<string>",
            "count": 4503599627370495,
            "window": "30d",
            "factor": 123,
            "low": 4503599627370495,
            "high": 4503599627370495,
            "openEnded": true
          }
        ],
        "unverifiedSources": [
          "<string>"
        ],
        "unmeasuredSources": [
          {
            "source": "<string>",
            "typicalShare": 123,
            "reason": "<string>"
          }
        ],
        "caveats": [
          "<string>"
        ],
        "prior": {
          "source": "google-trends",
          "monthly": 4503599627370495,
          "low": 4503599627370495,
          "high": 4503599627370495
        },
        "disagreement": true
      },
      "bareVolume": {
        "low": 4503599627370495,
        "high": 4503599627370495,
        "band": "quiet",
        "basis": "analog",
        "window": "30d",
        "openEnded": true,
        "perSource": [
          {
            "source": "<string>",
            "count": 4503599627370495,
            "window": "30d",
            "factor": 123,
            "low": 4503599627370495,
            "high": 4503599627370495,
            "openEnded": true
          }
        ],
        "unverifiedSources": [
          "<string>"
        ],
        "unmeasuredSources": [
          {
            "source": "<string>",
            "typicalShare": 123,
            "reason": "<string>"
          }
        ],
        "caveats": [
          "<string>"
        ],
        "prior": {
          "source": "google-trends",
          "monthly": 4503599627370495,
          "low": 4503599627370495,
          "high": 4503599627370495
        },
        "disagreement": true
      },
      "variant": {
        "sampleSize": 4503599627370495,
        "anchoredShare": 0.5,
        "excludedShare": 0.5,
        "retainedShare": 0.5,
        "collisionRatio": 0.5
      },
      "flagged": true
    }
  ],
  "calibration": {
    "fittedAt": "<string>"
  },
  "elapsedMs": 4503599627370495
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}