Skip to main content
POST
/
scraper
/
{scraper_id}
/
{endpoint_name}
Execute an API endpoint (POST)
curl --request POST \
  --url https://api.parse.bot/scraper/{scraper_id}/{endpoint_name} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "page": 1
}'
import requests

url = "https://api.parse.bot/scraper/{scraper_id}/{endpoint_name}"

payload = { "page": 1 }
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({page: 1})
};

fetch('https://api.parse.bot/scraper/{scraper_id}/{endpoint_name}', 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.parse.bot/scraper/{scraper_id}/{endpoint_name}",
  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([
    'page' => 1
  ]),
  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://api.parse.bot/scraper/{scraper_id}/{endpoint_name}"

	payload := strings.NewReader("{\n  \"page\": 1\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://api.parse.bot/scraper/{scraper_id}/{endpoint_name}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"page\": 1\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/scraper/{scraper_id}/{endpoint_name}")

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  \"page\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "title": "A Light in the Attic",
  "price": 51.77,
  "rating": 3
}
{
  "error": {
    "status": "stale_input",
    "kind": "input_format_invalid",
    "message": "trip_type must be 'one_way' or 'round_trip'"
  },
  "status_code": 422
}
{
  "error": {
    "error": "Rate limit exceeded",
    "message": "Too many requests in a short burst. Retry in 5s.",
    "limit_type": "burst",
    "retry_after": 5
  },
  "status_code": 429
}
{
  "error": {
    "status": "error",
    "kind": "scraper_bug",
    "message": "The scraper crashed during execution. This could be due to bad input, broken scraper code, or a website update."
  },
  "status_code": 500
}
{
  "error": {
    "status": "upstream_error",
    "upstream_status_code": 404,
    "message": "The target site returned HTTP 404. See `snippet` for the upstream response body.",
    "snippet": "<html>Product not found</html>",
    "url": "https://example.com/products/invalid-sku"
  },
  "status_code": 502
}
{
  "error": {
    "status": "blocked",
    "block_type": "datadome",
    "vendor": "datadome",
    "kind": "antibot_solvable",
    "attempts": 3,
    "retry_after": 60,
    "message": "Service temporarily unavailable - site protection blocking all proxies"
  },
  "status_code": 503
}

Authorizations

​
X-API-Key
string
header
required

API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

Path Parameters

​
scraper_id
string
required
​
endpoint_name
string
required

Body

application/json

Endpoint-specific parameters (see the endpoint's input_params for the schema)

Response

Success — the endpoint's own JSON (shape defined by its return_schema).

On success (HTTP 200) the body is the endpoint's own JSON — the shape described by its return_schema — not a fixed wrapper. This generic schema documents the fallback fields present when output can't be parsed. See the ExecutionError schema for non-2xx responses.

​
status
string

Present on fallback/error envelopes; absent on a normal successful response (which is just the endpoint's data).

​
scraper_id
string
​
execution_time
number | null

Execution time in seconds