{"id":20314894,"url":"https://github.com/catchpoint/webpagetest.crawler","last_synced_at":"2025-08-11T21:04:15.658Z","repository":{"id":49032538,"uuid":"376901561","full_name":"catchpoint/WebPageTest.crawler","owner":"catchpoint","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-17T18:38:49.000Z","size":164,"stargazers_count":1,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-24T09:06:27.151Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/catchpoint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-14T17:15:46.000Z","updated_at":"2025-01-17T18:38:47.000Z","dependencies_parsed_at":"2025-01-17T15:29:07.593Z","dependency_job_id":"9c4ac7df-3840-4836-9362-d3d639c5c1ab","html_url":"https://github.com/catchpoint/WebPageTest.crawler","commit_stats":null,"previous_names":["catchpoint/webpagetest.crawler"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/catchpoint/WebPageTest.crawler","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2FWebPageTest.crawler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2FWebPageTest.crawler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2FWebPageTest.crawler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2FWebPageTest.crawler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catchpoint","download_url":"https://codeload.github.com/catchpoint/WebPageTest.crawler/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2FWebPageTest.crawler/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269956171,"owners_count":24503113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T18:17:07.472Z","updated_at":"2025-08-11T21:04:15.613Z","avatar_url":"https://github.com/catchpoint.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://docs.webpagetest.org/img/wpt-navy-logo.png\" alt=\"WebPageTest Logo\" /\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://docs.webpagetest.org/api/integrations/#officially-supported-integrations\"\u003eLearn about more WebPageTest API Integrations in our docs\u003c/a\u003e\u003c/p\u003e\n\n# WebPageTest Crawler\n\nThe WebPageTest Crawler, crawls through the website to fetch URLs and then runs test on them. Level and URL limit can be given.\n\n![image](https://user-images.githubusercontent.com/31168643/122060468-40ad6680-ce0b-11eb-9f25-ea51eaac22f9.png)\n\nRequires node, npm.\n\n### 1. Installing Packages\n\nOnce you have cloned the project run `npm install` to install dependencies. requires node v22.13.0 minumum\n\n```bash\nnpm install\n```\n\n### 2. Updating config values\n\nThere are 3 main config values : -\n\n1. wpt_api_key - Check [here](https://docs.webpagetest.org/api/keys/) the API documentation\n2. level - integer value, specifies maximum depth the crawler should crawl.\n3. limit - integer value, specifies maximum limit of URLs need to tested.\n   Note : - Crawling stops if either of them reaches a limit.\n\n### 3. Adding a initial URLs txt file\n\nYou can add your initial set of URLs to the startingUrls.txt file by seperating them using a comma.\n\n![image](https://user-images.githubusercontent.com/31168643/122050545-2a021200-ce01-11eb-9400-31e7716791c0.png)\n\n### 4. Lets fire it up\n\n```bash\nnpm run build \u0026 node build/index.js -k [YOUR_API_KEY] -f ./startingUrls.txt\n```\n\nBooyah, once the crawl-testing is complete you'll have a report.csv file which includes performance details of the URLs crawled.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatchpoint%2Fwebpagetest.crawler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatchpoint%2Fwebpagetest.crawler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatchpoint%2Fwebpagetest.crawler/lists"}