Ruby Code Examples

The following are code examples on how to integrate the ScrapeOps Residential Proxy Aggregator with your Ruby Scrapers using httparty.

Authorisation - API Key

To use the ScrapeOps proxy, you first need an API key which you can get by signing up for a free account here.

Your API key must be included with every request using the api_key query parameter otherwise the API will return a 403 Forbidden Access status code.

Basic Request

The following is some example code to send a URL to the ScrapeOps Proxy port http://scrapeops:YOUR_API_KEY@residential-proxy.scrapeops.io:8181.

First, you'll need to install the 'httparty' gem. Run this command in your terminal:

gem install httparty

Here is the example code.

require 'httparty'

api_key = 'YOUR_API_KEY'
target_url = 'https://httpbin.org/ip'

response = HTTParty.get(
  target_url,
  http_proxyaddr: 'residential-proxy.scrapeops.io',
  http_proxyport: 8181,
  http_proxyuser: 'scrapeops',
  http_proxypass: api_key,
  timeout: 120
)

puts 'Body: ' + response.body

ScrapeOps will take care of the proxy selection and rotation for you so you just need to send us the URL you want to scrape.

Response Format

After receiving a response from one of our proxy providers the ScrapeOps Residential Proxy Aggregator will then respond with the raw HTML content of the target URL along with a response code:

<html>
  <head>
     ...
  </head>
  <body>
     ...
  </body>
</html>  

Status Codes

The ScrapeOps Residential Proxy Aggregator will return the status code returned by the target website.

However, if the proxy port will return the following status codes if there are specific errors in your request:

Status Code	Billed	Description
`400`	No	Bad request. Either your `url` or query parameters are incorrectly formatted.
`401`	No	You have consumed all your credits. Either turn off your scraper, or upgrade to a larger plan.
`403`	No	Either no `api_key` included on request, or `api_key` is invalid.

Here is the full list of status codes the Proxy Port returns.

Advanced Functionality

To enable advanced proxy functionality when using the Residential Proxy endpoint you need to pass parameters by adding them to username, separated by periods.

For example, if you want to enable Country Geotargeting with a request, the username would be scrapeops.country=us.

require 'httparty'

api_key = 'YOUR_API_KEY'
target_url = 'https://httpbin.org/ip'

response = HTTParty.get(
  target_url,
  http_proxyaddr: 'residential-proxy.scrapeops.io',
  http_proxyport: 8181,
  http_proxyuser: 'scrapeops.country=us',
  http_proxypass: api_key,
  timeout: 120
)

puts 'Body: ' + response.body

Check out this guide to see the full list of advanced functionality available.

Timeout

The ScrapeOps proxy keeps retrying a request for up to 2 minutes before returning a failed response to you.

To use the Proxy correctly, you should set the timeout on your request to a least 2 minutes to avoid you getting charged for any bandwidth that you consumed before the Proxy responded.

Ruby Code Examples

Authorisation - API Key​

Basic Request​

Response Format​

Status Codes​

Here is the full list of status codes the Proxy Port returns.​

Advanced Functionality​

Timeout​