Parameters
Request
Section titled “Request”| Field | Required | Where | Description |
|---|---|---|---|
token |
Yes | Query string | Your API token, on every request including /balance. |
url |
Yes | Query string or JSON body | The page to fetch. URL-encode it. |
module |
No | Query string or JSON body | How the page is fetched and parsed. See Modules. |
Endpoints
Section titled “Endpoints”| Path | Method | Purpose |
|---|---|---|
/ |
GET |
Scrape a URL with query-string parameters |
/ |
POST |
Scrape a URL with a JSON body |
/balance |
GET |
Remaining account balance |
Base URL: http://api.scraping.rayobyte.com/
Encoding the target URL
Section titled “Encoding the target URL”url is a URL inside a URL. Encode it, or the first & in your target’s query
string ends the parameter and everything after it is read as an argument to us.
curl -G "http://api.scraping.rayobyte.com/" \ --data-urlencode "token=YOUR_TOKEN" \ --data-urlencode "url=https://example.com/search?q=widgets&page=2"With POST this stops being a concern, because the URL sits in a JSON string.
Web Unblocker
Section titled “Web Unblocker”Web Unblocker is a proxy port rather than an API endpoint. It takes no query parameters, and targeting goes on the proxy password.
| Option | Form |
|---|---|
| Country | -country-US appended to the password |
Modules accept their own options on top of these. Ask support which ones apply to the module you are using.
Was this page helpful?
Thanks — that helps us fix it.