Web Scraping Service API Documentation

GET /api/health

Health check endpoint to verify service status

Response

              Status: 200 OK Body:
              "Ok"
            

Try it out

Click "Send Request" to test the endpoint

GET /api/parse

Extract main textual content from a single webpage

Parameters

Name	Type	Required	Description
url	string	Yes	The URL of the webpage to parse

Response Examples

              Status: 200 OK {
              "content": "This is the extracted main content from the
              webpage..." }
            

              Status:
              400 Bad Request {
              "message": "Missing URL" }
            

Try it out

URL:

Enter a URL and click "Send Request" to test

GET /api/scrape

Search multiple engines and scrape content from result pages

Parameters

Name	Type	Required	Description
q	string	Yes	Search query to find and scrape relevant pages

Response Examples

              Status: 200 OK {
              "message": "Ok", "data": [ { "url": "https://example.com/page1",
              "search_engine": "brave", "raw_data": "Content from the scraped
              page..." }, { "url": "https://example.com/page2", "search_engine":
              "yahoo", "raw_data": "More content from another page..." } ] }
            

              Status:
              500 Internal Server Error
              { "error": "Internal server error" }
            

Try it out

Search Query:

Enter a search query and click "Send Request" to test

GET /api/image

Extract all image sources from a single webpage

Parameters

Name	Type	Required	Description
url	string	Yes	The URL of the webpage to extract images from

Response Examples

              Status: 200 OK {
              "url": "https://example.com",
              "images": [
                "https://example.com/logo.png",
                "https://example.com/hero.jpg"
              ] }
            

              Status:
              400 Bad Request {
              "message": "Missing URL" }
            

Try it out

URL:

Enter a URL and click "Send Request" to test

GET /api/images

Search multiple engines and extract images from each result page

Parameters

Name	Type	Required	Description
q	string	Yes	Search query to find pages and extract their images

Response Examples

              Status: 200 OK {
              "message": "Ok", "data": [ { "url": "https://example.com/page1",
              "search_engine": "brave", "images": [
                "https://example.com/page1/img1.jpg",
                "https://example.com/page1/img2.png"
              ] }, { "url": "https://example.com/page2", "search_engine":
              "yahoo", "images": [
                "https://example.com/page2/hero.webp"
              ] } ] }
            

              Status:
              500 Internal Server Error
              { "error": "Internal server error" }
            

Try it out

Search Query:

Enter a search query and click "Send Request" to test