[{"_1":2,"_165":-5,"_166":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_93":-5,"_94":95,"_134":-5,"_135":11,"_136":17,"_137":11,"_138":-5,"_139":140},"canonicalUrl","https://hub.docker.com/r/nionmaron/playwright-api/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","nionmaron","reponame","playwright-api","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_48":49,"_51":52,"_53":54,"_55":11,"_56":57,"_58":59,"_60":61,"_38":30,"_27":28,"_63":64,"_65":50,"_66":67,"_68":69,"_70":71,"_72":-5,"_73":67,"_74":75,"_76":11,"_77":28,"_78":79,"_84":11,"_85":86,"_90":28,"_91":92},"categories",[37,42,45],{"_38":39,"_40":41},"name","API management","slug","api-management",{"_38":43,"_40":44},"Data science","data-science",{"_38":46,"_40":47},"Databases & storage","databases-and-storage","content_types",[50],"image","date_registered","2025-01-05T22:40:45.003232Z","description","The Playwright API is a RESTful API developed with FastAPI and Playwright.","is_private","last_updated","2025-01-05T22:40:45.070279Z","last_modified","2025-01-05T22:43:56.252782Z","media_types",[62],"application/vnd.docker.container.image.v1+json","pull_count",87,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Playwright API\n\n![Docker Image CI](https://img.shields.io/docker/v/nionmaron/playwright-api?sort=semver)\n![Docker Pulls](https://img.shields.io/docker/pulls/nionmaron/playwright-api)\n![License](https://img.shields.io/docker/l/nionmaron/playwright-api)\n\n## 📄 Description\n\nThe **Playwright API** is a **RESTful API** developed with **FastAPI** and **Playwright**, designed for **web content scraping**. It allows you to submit a list of URLs and receive back the text extracted from the `

`, `

`, and `
` tags of each page, formatted in Markdown. This project is containerized with Docker, simplifying deployment and usage.\n\n## 🚀 Features\n\n- Selective Extraction: Collects only the titles (`

`, `

`) and paragraphs (`
`) from web pages.\n- Markdown Formatting: Converts the extracted content into Markdown, preserving the hierarchy of titles and the formatting of paragraphs.\n- RESTful API: Simple and intuitive interface for integration with other applications.\n- Docker Containerization: Facilitates deployment and scalability of the application.\n\n## 🛠️ Technologies Used\n\n- FastAPI: Python framework for building fast and efficient APIs.\n- Playwright: Browser automation library, ideal for modern scraping.\n- Docker: Platform for developing, shipping, and running applications in containers.\n- BeautifulSoup4: Python library for parsing HTML and XML.\n- Markdownify: Library for converting HTML to Markdown.\n\n## 📦 Docker Image\n\n### Image Name\n\n`nionmaron/playwright-api:v0.0.1`\n\n### How to Run\n\nTo start the API using Docker, execute the following command:\n\n```bash\ndocker run -d --name playwright-api -p 8000:8000 nionmaron/playwright-api:v0.0.1\n```\n\n- Parameters:\n - `-d`: Runs the container in detached mode (background).\n - `--name playwright-api`: Names the container for easy reference.\n - `-p 8000:8000`: Maps port `8000` of the host to port `8000` of the container.\n\n### Accessing the API\n\nAfter starting the container, the API will be accessible at:\n\n```\nhttp://localhost:8000\n```\n\n### Interactive Documentation\n\nAccess the interactive documentation generated by FastAPI at:\n\n```\nhttp://localhost:8000/docs\n```\n\n## 📚 How to Use\n\n### Endpoint `/scrape`\n\n#### Method: `POST`\n\n#### Description:\nReceives a list of URLs and returns the content extracted from the `

`, `

`, and `
` tags in Markdown format.\n\n#### Payload (JSON):\n\n```json\n{\n \"urls\": [\n \"https://www.example.com\",\n \"https://www.anotherexample.com\"\n ]\n}\n```\n\n#### Response (JSON):\n\n```json\n{\n \"https://www.example.com\": \"# Page Title\\n\\nParagraph content...\\n## Subtitle\\n\\nMore content...\\n### Smaller Subtitle\\n\\nEven more content...\\n\",\n \"https://www.anotherexample.com\": \"# Another Title\\n\\nParagraph content...\\n\"\n}\n```\n\n#### cURL Request Example:\n\n```bash\ncurl -X POST \"http://localhost:8000/scrape\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"urls\": [\"https://www.infomoney.com.br/\"]}'\n```\n\n#### Response Example:\n\n```json\n{\n \"https://www.infomoney.com.br/\": \"# Page Title\\n\\nParagraph content...\\n## Subtitle\\n\\nMore content...\\n### Smaller Subtitle\\n\\nEven more content...\\n\"\n}\n```\n\n### Example Usage with R\n\nIf you use R to interact with the API, here's an example script:\n\n```R\n# Load necessary packages\nlibrary(httr)\nlibrary(jsonlite)\n\n# Define the API URL and the URL you want to scrape\napi_url <- \"http://localhost:8000/scrape\"\ntarget_urls <- c(\"https://www.infomoney.com.br/\") # Add more URLs as needed\n\n# Build the JSON payload\npayload <- list(urls = as.list(target_urls))\npayload_json <- toJSON(payload, auto_unbox = TRUE)\n\n# Send the POST request to the API\nresponse <- POST(\n url = api_url,\n body = payload_json,\n encode = \"json\",\n content_type_json()\n)\n\n# Check if the request was successful\nif (status_code(response) == 200) {\n # Parse the response content\n response_content <- content(response, as = \"text\", encoding = \"UTF-8\")\n response_json <- fromJSON(response_content)\n \n for (url in target_urls) {\n markdown_text <- response_json[[url]]\n \n if (grepl(\"^Error\", markdown_text)) {\n cat(sprintf(\"Error processing %s: %s\\n\", url, markdown_text))\n } else {\n # Display the Markdown text in the console\n cat(sprintf(\"Markdown Text for %s:\\n\\n\", url))\n cat(markdown_text)\n \n # Optional: Save the text to a Markdown file\n safe_filename <- gsub(\"https?://\", \"\", url)\n safe_filename <- gsub(\"[^a-zA-Z0-9_-]\", \"_\", safe_filename)\n filename <- paste0(safe_filename, \".md\")\n writeLines(markdown_text, con = filename)\n cat(sprintf(\"\\n\\nContent saved to '%s'.\\n\\n\", filename))\n }\n }\n \n} else {\n # If the request failed, display an error message\n cat(\"Error accessing the API. Status:\", status_code(response), \"\\n\")\n cat(\"Error message:\", content(response, as = \"text\", encoding = \"UTF-8\"), \"\\n\")\n}\n```\n\n## 🧰 Requirements\n\n- Docker: Ensure Docker is installed on your machine. [Install Docker](https://docs.docker.com/get-docker/)\n- Docker Hub Account: To pull the image from Docker Hub, you may need to be logged in. [Create a Docker Hub Account](https://hub.docker.com/signup)\n\n## 🔧 Configuration and Customization\n\nIf you wish to customize the API or adjust parameters, you can clone the repository and build the Docker image locally.\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/nionmaron/playwright-api.git\ncd playwright-api\n```\n\n### 2. Build the Docker Image\n\n```bash\ndocker build -t playwright-api:v0.0.1 .\n```\n\n### 3. Run the Docker Container\n\n```bash\ndocker run -d --name playwright-api -p 8000:8000 playwright-api:v0.0.1\n```\n\n## 📈 Monitoring and Logs\n\nTo view the API logs in real-time, use the following command:\n\n```bash\ndocker logs -f playwright-api\n```\n\nThis allows you to monitor requests, errors, and other relevant information directly in the terminal.\n\n## 📝 Final Considerations\n\n- Performance: Utilizing Playwright provides efficient and modern scraping capabilities but can be resource-intensive depending on the volume of requests.\n- Security: Always validate and sanitize incoming URLs to prevent scraping malicious sites.\n- Legality: Ensure compliance with the Terms of Service of the websites you are scraping and adhere to ethical scraping practices.\n\n## 📄 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## 📫 Contact\n\nDeveloped by [Nion Maron](mailto:nionmaron@example.com).\n\nFor any questions or suggestions, feel free to reach out.\n\n","has_starred","hub_user","immutable_tags_settings",{"_80":11,"_81":82},"enabled","rules",[83],".*","is_automated","permissions",{"_87":17,"_88":11,"_89":11},"read","write","admin","user","storage_size",858557197,"orgData","recentTags",[96],{"_97":50,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_56":123,"_124":99,"_125":28,"_126":62,"_38":127,"_128":129,"_130":114,"_131":123,"_132":71,"_133":17},"content_type","creator",24537836,"digest","sha256:8ea75246df3acf7fa59e8f89f169cccc0f72398bf519cff347d5514b175aeeab","full_size",858547266,"id",824312563,"images",[108],{"_109":110,"_100":101,"_111":112,"_113":114,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":103,"_68":71,"_122":-5},"architecture","amd64","features","","last_pulled","2026-09-15T09:23:00.055187627Z","last_pushed","2025-01-05T22:40:45Z","os","linux","os_features","os_version","size","variant","2025-01-05T22:40:44.232624Z","last_updater","last_updater_username","media_type","v.0.0.1","repository",26115859,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":143,"_153":154,"_139":163,"_164":11},{"_35":144,"_48":148,"_51":52,"_53":54,"_55":11,"_56":57,"_58":59,"_60":149,"_38":30,"_27":28,"_63":64,"_65":50,"_66":67,"_68":69,"_70":71,"_72":-5,"_73":67,"_74":75,"_76":11,"_77":28,"_78":150,"_84":11,"_85":152,"_90":28,"_91":92},[145,146,147],{"_38":39,"_40":41},{"_38":43,"_40":44},{"_38":46,"_40":47},[50],[62],{"_80":11,"_81":151},[83],{"_87":17,"_88":11,"_89":11},"tags",{"_155":69,"_156":-5,"_157":-5,"_158":159},"count","next","previous","results",[160],{"_97":50,"_98":99,"_100":101,"_102":103,"_104":105,"_106":161,"_56":123,"_124":99,"_125":28,"_126":62,"_38":127,"_128":129,"_130":114,"_131":123,"_132":71,"_133":17},[162],{"_109":110,"_100":101,"_111":112,"_113":114,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":103,"_68":71,"_122":-5},[],"canDeleteTags","actionData","errors"]

`, `

`, `

`, and `` tags of each page, formatted in **Markdown**. This project is containerized with **Docker**, simplifying deployment and usage.\n\n## 🚀 Features\n\n- **Selective Extraction:** Collects only the titles (`

`, `

`, `

`, `

`, `

`, and `
` tags of each page, formatted in Markdown. This project is containerized with Docker, simplifying deployment and usage.\n\n## 🚀 Features\n\n- Selective Extraction: Collects only the titles (`

nionmaron/playwright-api

Tags for nionmaron/playwright-api