castomAPI
Odbierz klucz
POST /v1/serp/check-url od 60 tokenów PRO Klucz API SERP

Wyszukaj frazę i podaj pozycję rankingową Twojego URL-a (i opcjonalnie…

Search a phrase and report the ranking position of your URL (and optionally a rival URL): the first result on the same host whose path is that URL's path or below it. `https://example.com` matches any page of example.com or www.example.com;…

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź 

{
  "pagesFetched": 20,
  "results": [],
  "rivalPosition": "<rival position>",
  "status": "success",
  "tokensDeducted": 60,
  "userPosition": "<user position>"
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Search a phrase and report the ranking position of your URL (and optionally a rival URL): the first result on the same host whose path is that URL's path or below it. `https://example.com` matches any page of example.com or www.example.com; `https://example.com/blog` matches /blog and /blog/post but not /blogging. Scheme, query string and letter case are ignoredage of 10 results actually fetched)

Żądanie

Treść

PoleTypWymaganeOpis
countrystringtak
langstringtak
phrasestringtak
respSizeintegernie
rivalUrlToCheckstringnie
searchEngineenumtakOne of: google, bing.
urlToCheckstringtak

Przykładowe żądanie

{
  "country": "PL",
  "lang": "en",
  "phrase": "<phrase>",
  "respSize": 10,
  "rivalUrlToCheck": "https://example.com/page",
  "searchEngine": "google",
  "urlToCheck": "https://example.com/page"
}

Odpowiedź

PoleTypOpis
pagesFetchedinteger
resultsarray<object>
rivalPositionany
statusstring
tokensDeductedinteger
userPositionany

Przykładowa odpowiedź

{
  "pagesFetched": 20,
  "results": [],
  "rivalPosition": "<rival position>",
  "status": "success",
  "tokensDeducted": 60,
  "userPosition": "<user position>"
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/serp/check-url' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"country": "PL", "lang": "en", "phrase": "<phrase>", "respSize": 10, "rivalUrlToCheck": "https://example.com/page", "searchEngine": "google", "urlToCheck": "https://example.com/page"}'
const res = await fetch('https://app.castomapi.com/v1/serp/check-url', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"country": "PL", "lang": "en", "phrase": "<phrase>", "respSize": 10, "rivalUrlToCheck": "https://example.com/page", "searchEngine": "google", "urlToCheck": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/serp/check-url', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"country": "PL", "lang": "en", "phrase": "<phrase>", "respSize": 10, "rivalUrlToCheck": "https://example.com/page", "searchEngine": "google", "urlToCheck": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/serp/check-url',
    headers={'x-api-key': '<your-api-key>'},
    json={"country": "PL", "lang": "en", "phrase": "<phrase>", "respSize": 10, "rivalUrlToCheck": "https://example.com/page", "searchEngine": "google", "urlToCheck": "https://example.com/page"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/serp/check-url');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['country' => 'PL', 'lang' => 'en', 'phrase' => '<phrase>', 'respSize' => 10, 'rivalUrlToCheck' => 'https://example.com/page', 'searchEngine' => 'google', 'urlToCheck' => 'https://example.com/page']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje od 60 tokenów. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa. 60 tokenów za każdą pobraną stronę wyników (do 10 wyników). Dostępne w planach PRO i Enterprise: ta operacja zużywa własne klucze lub limity castomAPI. Klucz z planu darmowego dostaje 403 i nie jest rozliczany.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Wyszukaj frazę i podaj pozycję rankingową Twojego URL-a (i opcjonalnie…?

od 60 tokenów za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie. 60 tokenów za każdą pobraną stronę wyników (do 10 wyników).

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json