Introduction

Loading API description...

Base URL

Loading...

Version

1.0.1

Authentication

Scrapland API uses bearer token authentication. All API requests must include your API key in the Authorization header.

HTTP Header 
Authorization: Bearer YOUR_API_KEY

You can obtain your API key from the Scrapland Dashboard after creating an account. Keep your API key secure and don't share it publicly.

API Key Management

Enter your API key below to use with the "Try it out" feature. Your key will be stored in your browser for convenience.

Error Handling

The Scrapland API uses standard HTTP response codes to indicate success or failure. Error responses include a JSON object with detailed information to help troubleshoot issues.

Code Description
200 - OK Request succeeded. The response body contains the requested data.
400 - Bad Request Invalid request parameters or malformed request. Check the error message for details.
401 - Unauthorized Missing or invalid API key. Check your Authorization header.
403 - Forbidden Valid API key but insufficient permissions for the requested operation.
404 - Not Found The requested resource does not exist.
429 - Too Many Requests Rate limit exceeded. See the X-RateLimit-Reset header for when to retry.
500 - Server Error Unexpected error on the Scrapland servers. Please contact support if persistent.

Error Response Format

JSON 
{
  "error": {
    "code": "invalid_parameter",
    "message": "The parameter 'limit' must be an integer between 1 and 100",
    "details": {
      "parameter": "limit",
      "value": "200",
      "constraint": "1-100"
    }
  }
}

API Reference

Rate Limits

To ensure fair usage and service stability, Scrapland API enforces rate limits on API requests. Rate limits are applied based on your subscription plan.

Plan Requests per minute Requests per day
Free 10 1,000
Basic 60 10,000
Pro 300 100,000
Enterprise Custom Custom

Rate Limit Headers

The API includes the following headers in responses to help you track your rate limit usage:

Header Description
X-RateLimit-Limit The maximum number of requests allowed in the current time window
X-RateLimit-Remaining The number of requests remaining in the current time window
X-RateLimit-Reset The time (Unix timestamp) when the current rate limit window resets

Best Practices

Optimize Your Requests

  • Use pagination parameters (limit and offset) to retrieve only the data you need
  • Cache responses when appropriate to reduce unnecessary API calls
  • Implement retry logic with exponential backoff for handling rate limits and temporary failures
  • Set reasonable timeouts for your API requests to handle slow responses

Error Handling

  • Always check the HTTP status code and error messages in API responses
  • Implement proper error handling in your application to gracefully handle API errors
  • Log detailed error information for troubleshooting

Security

  • Keep your API key secure and never expose it in client-side code
  • Rotate your API keys periodically
  • Use environment variables to store API keys in your application
  • Implement proper access controls for your application's use of the API