Skip to main content
POST
/
api
/
scrape
/
{scraperId}
curl --request POST \
  --url https://app.manypi.com/api/scrape/{scraperId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/product/123"
}
'
{
  "success": true,
  "data": {
    "title": "Wireless Bluetooth Headphones",
    "price": "$79.99",
    "rating": 4.5,
    "reviews": 1234,
    "inStock": true,
    "description": "Premium noise-cancelling headphones with 30-hour battery life"
  },
  "metadata": {
    "scraperId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "tokensUsed": 1500,
    "creditsCost": 1500,
    "creditsRemaining": 8500
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Generate your API key in the ManyPI dashboard under 'API Access'. Include it in the Authorization header as: Authorization: Bearer YOUR_API_KEY

Path Parameters

​
scraperId
string<uuid>
required

Unique identifier of the scraper to execute. Find this in your dashboard under Scrapers.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Optional configuration for the scraping request

​
url
string<uri>
required

Target URL to scrape. Must be a valid HTTP/HTTPS URL.

Example:

"https://example.com/product/123"

​
options
object

Optional configuration for the scraping request

Response

Scraping completed successfully

​
success
boolean
required

Indicates whether the scraping operation was successful

Example:

true

​
data
object
required

Extracted data matching your scraper's schema. Structure varies based on your scraper configuration.

Example:
{
  "title": "Product Name",
  "price": "$99.99",
  "rating": 4.5,
  "inStock": true
}
​
metadata
object
required

Information about the scraping operation