Skip to content

SharkPool-SP/reef-proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reef Proxy Documentation

Reef Proxy is a free CORS proxy that provides multiple methods for fetching and scraping web resources. This page documents all available endpoints and how to use them.

Support Reef Proxy

Reef Proxy is a free service. Running and maintaining the proxy requires ongoing server costs. If you find it useful, please consider supporting us with a donation.

Donate with PayPal

Alternatively, contact me on GitHub or Discord to discuss E-Transfers.

🛈 Rate Limits and Privacy

Reef Proxy temporarily stores your IP address solely for rate limiting. IP addresses are not permanently stored or shared. Each client is limited to 50 requests per hour.

Available Endpoints

  • /get - Performs a GET request to the target URL.
  • /post - Performs a POST request to the target URL.
  • /scrape - Loads and returns the rendered HTML of a webpage.

🛈 Specifying the Target URL

Every request must include the target URL using one of the following methods:

Query parameter: ?url=https://example.com

Request header: "x-target-url": https://example.com

/get

Sends a standard HTTP GET request to the specified URL and returns the response. Additional query parameters are forwarded to the target URL.

/post

Sends an HTTP POST request to the specified URL. Request headers and the request body are forwarded to the target whenever possible.

/scrape

Opens the requested webpage in a browser and returns the rendered HTML after waiting for the page to load.

Use the optional wait query parameter to specify how many seconds to wait before the page is scraped.

/scrape?url=https://example.com&wait=5

The wait value must be between 0 and 10 seconds. If omitted, Reef Proxy uses the default wait time.

About

Free CORS proxy with multiple methods for fetching and scraping web resources

Topics

Resources

License

Stars

3 stars

Watchers

0 watching

Forks

Contributors