{"id":18665952,"url":"https://github.com/medartus/url-preview","last_synced_at":"2025-08-12T06:47:00.943Z","repository":{"id":37914143,"uuid":"255017261","full_name":"medartus/url-preview","owner":"medartus","description":"📝 Get HTML metadata from any link with a simple request","archived":false,"fork":false,"pushed_at":"2023-02-12T11:26:27.000Z","size":591,"stargazers_count":7,"open_issues_count":10,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-29T21:04:33.885Z","etag":null,"topics":["jsonld","metadata","preview","url-preview"],"latest_commit_sha":null,"homepage":"https://urlpreview.vercel.app","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/medartus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2020-04-12T05:45:14.000Z","updated_at":"2025-05-20T13:45:21.000Z","dependencies_parsed_at":"2024-11-07T08:32:26.963Z","dependency_job_id":"41546590-9322-421c-b4eb-2eb0f597a24d","html_url":"https://github.com/medartus/url-preview","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/medartus/url-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/medartus%2Furl-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/medartus%2Furl-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/medartus%2Furl-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/medartus%2Furl-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/medartus","download_url":"https://codeload.github.com/medartus/url-preview/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/medartus%2Furl-preview/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270016577,"owners_count":24512963,"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-12T02:00:09.011Z","response_time":80,"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":["jsonld","metadata","preview","url-preview"],"created_at":"2024-11-07T08:29:48.593Z","updated_at":"2025-08-12T06:47:00.906Z","avatar_url":"https://github.com/medartus.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Url Preview 💻\n\nUrl preview is an free API providing metadata, jsonld from any webpage. You can also get data to preview url like on facebook, linkedind or twitter.\n\n## Usage 👩‍💻\n\nYou only have to do some http request to the api : `https://urlpreview.vercel.app/api/v1`\n\n### GET /preview\n\n#### Request\n\nExample : `https://urlpreview.vercel.app/api/v1/preview?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ`\n\n| Parameters |    Value     |\n| :--------: | :----------: |\n|   `url`    | Url to scrap |\n\n\u003e To avoid any problem, don't forget to [url encode](https://www.urlencoder.org/) the value you pass to the url parameter !\n\n#### Response\n\nResponse body:\n\n```json\n{\n  \"title\": \"Rick Astley - Never Gonna Give You Up (Video)\",\n  \"description\": \"Rick Astley's official music video for “Never Gonna Give You Up” Listen to Rick Astley: https://RickAstley.lnk.to/_listenYD Subscribe to the official Rick As...\",\n  \"image\": \"https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg\",\n  \"domain\": \"www.youtube.com\"\n}\n```\n\n### GET /metadata\n\n#### Request\n\nExample : `https://urlpreview.vercel.app/api/v1/metadata?url=https%3A%2F%2Fwww.theverge.com%2F2017%2F11%2F16%2F16667366%2Ftesla-semi-truck-announced-price-release-date-electric-self-driving\u0026suObject=true`\n\n| Parameters  |          Value          |\n| :---------: | :---------------------: |\n|    `url`    |      Url to scrap       |\n| `subObject` | Getting object response |\n\n\u003e To avoid any problem, don't forget to [url encode](https://www.urlencoder.org/) the value you pass to the url parameter !\n\n#### Response\n\nResponse body:\n\n```json\n{\n  \"charset\": \"utf-8\",\n  \"Content-Type\": \"text/html; charset=UTF-8\",\n  \"X-UA-Compatible\": \"IE=edge\",\n  \"viewport\": \"width=device-width, initial-scale=1, shrink-to-fit=no\",\n  \"apple-mobile-web-app-title\": \"Verge\",\n  \"article\": {\n    \"publisher\": \"http://www.facebook.com/verge\",\n    \"author\": \"http://facebook.com/zacestrada\",\n    \"published_time\": \"2017-11-16T23:47:07-05:00\",\n    \"modified_time\": \"2017-11-16T23:47:07-05:00\"\n  },\n  \"author\": \"Zac Estrada\",\n  \"style-tools\": \"https://www.theverge.com/style/community/372/d321565222175dac2dea8810c0bb0352/tools.css\",\n  \"google-site-verification\": \"IucFf_TKtbFFH8_YeFyEteQIwYPdANM1R46_U9DpAr4\",\n  \"msvalidate\": {\n    \"01\": \"D385D0326A3AE144205C298DB34B4E94\"\n  },\n  \"ahrefs-site-verification\": \"1e57a609922037a3fbdc1c22efd7334113f174f15608f37e1b8538a7b4ce64c3\",\n  \"description\": \"500 miles of range and more aerodynamic than a supercar\",\n  \"og\": {\n    \"description\": \"500 miles of range and more aerodynamic than a supercar\",\n    \"image\": \"https://cdn.vox-cdn.com/thumbor/iDt70XEkiWUnA-NhWSnRio8HoHg=/0x75:3840x2085/fit-in/1200x630/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\",\n    \"site_name\": \"The Verge\",\n    \"title\": \"This is the Tesla Semi truck\",\n    \"type\": \"article\",\n    \"url\": \"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving\"\n  },\n  \"fb\": {\n    \"app_id\": \"549923288395304\"\n  },\n  \"twitter\": {\n    \"card\": \"summary_large_image\",\n    \"url\": \"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving\",\n    \"title\": \"This is the Tesla Semi truck\",\n    \"description\": \"500 miles of range and more aerodynamic than a supercar\",\n    \"image\": \"https://cdn.vox-cdn.com/thumbor/n32q2zYeYLQGqoLhoZyQij0iFfw=/0x120:3840x2040/fit-in/1200x600/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\",\n    \"site\": \"verge\"\n  },\n  \"sailthru\": {\n    \"title\": \"This is the Tesla Semi truck\",\n    \"tags\": \"general,the-verge,front-page,tech,transportation,cars,tesla,autonomous-cars\",\n    \"description\": \"500 miles of range and more aerodynamic than a supercar\",\n    \"date\": \"2017-11-16T23:47:07-05:00\",\n    \"image\": {\n      \"full\": \"https://cdn.vox-cdn.com/thumbor/FA1FPlEkmMBEWgC3trfRatP7H0w=/0x0:3840x2160/1600x900/cdn.vox-cdn.com/uploads/chorus_image/image/57642013/Semi_Front_Profile.0.jpg\",\n      \"thumb\": \"https://cdn.vox-cdn.com/thumbor/-E2SunSVupc9hq6MfQ3PjuXXgzo=/840x0:3000x2160/200x200/cdn.vox-cdn.com/uploads/chorus_image/image/57642013/Semi_Front_Profile.0.jpg\"\n    }\n  },\n  \"msapplication-TileImage\": \"https://cdn.vox-cdn.com/uploads/chorus_asset/file/7396113/221a67c8-a10f-11e6-8fae-983107008690.0.png\",\n  \"msapplication-TileColor\": \"#393092\",\n  \"theme-color\": \"\",\n  \"outbrainsection\": \"autonomous-cars\"\n}\n```\n\n### GET /jsonld\n\n#### Request\n\nExample : `https://urlpreview.vercel.app/api/v1/jsonld?url=https%3A%2F%2Fwww.theverge.com%2F2017%2F11%2F16%2F16667366%2Ftesla-semi-truck-announced-price-release-date-electric-self-driving`\n\n| Parameters |    Value     |\n| :--------: | :----------: |\n|   `url`    | Url to scrap |\n\n\u003e To avoid any problem, don't forget to [url encode](https://www.urlencoder.org/) the value you pass to the url parameter !\n\n#### Response\n\nResponse body:\n\n```json\n[\n  {\n    \"@context\": \"http://schema.org\",\n    \"@type\": \"NewsArticle\",\n    \"mainEntityOfPage\": \"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving\",\n    \"url\": \"https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving\",\n    \"headline\": \"This is the Tesla Semi truck\",\n    \"description\": \"500 miles of range and more aerodynamic than a supercar\",\n    \"speakable\": {\n      \"@type\": \"SpeakableSpecification\",\n      \"xpath\": [\n        \"/html/head/title\",\n        \"/html/head/meta[@name='description']/@content\"\n      ]\n    },\n    \"datePublished\": \"2017-11-16T23:47:07-05:00\",\n    \"dateModified\": \"2017-11-16T23:47:07-05:00\",\n    \"author\": [\n      {\n        \"@type\": \"Person\",\n        \"name\": \"Zac Estrada\"\n      }\n    ],\n    \"publisher\": {\n      \"@type\": \"Organization\",\n      \"name\": \"The Verge\",\n      \"logo\": {\n        \"@type\": \"ImageObject\",\n        \"url\": \"https://cdn.vox-cdn.com/uploads/chorus_asset/file/13668586/google_amp.0.png\",\n        \"width\": 600,\n        \"height\": 60\n      }\n    },\n    \"articleSection\": \"Front Page\",\n    \"keywords\": [\n      \"Front Page\",\n      \"Tech\",\n      \"Transportation\",\n      \"Cars\",\n      \"Tesla\",\n      \"Autonomous Cars\"\n    ],\n    \"about\": {\n      \"@type\": \"Event\",\n      \"name\": \"Tesla Semi Truck Event 2017\",\n      \"startDate\": \"2017-11-17T04:00:00+00:00\",\n      \"location\": {\n        \"@type\": \"Place\",\n        \"name\": \"Tesla Motors factory\",\n        \"address\": \"Hawthorne, California, USA\"\n      }\n    },\n    \"image\": [\n      {\n        \"@type\": \"ImageObject\",\n        \"url\": \"https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\",\n        \"width\": 1400,\n        \"height\": 1400\n      },\n      {\n        \"@type\": \"ImageObject\",\n        \"url\": \"https://cdn.vox-cdn.com/thumbor/l6nkV8CkJIdUrJIzHFWUFc1zLRM=/1400x1050/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\",\n        \"width\": 1400,\n        \"height\": 1050\n      },\n      {\n        \"@type\": \"ImageObject\",\n        \"url\": \"https://cdn.vox-cdn.com/thumbor/5Sqo6J73lBi1hwzEiKCQy6FLx3I=/1400x788/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\",\n        \"width\": 1400,\n        \"height\": 788\n      }\n    ],\n    \"thumbnailUrl\": \"https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg\"\n  }\n]\n```\n\n## License 🧾\n\nReleased under the MIT License.\n\nMaintained by [Marc-Etienne Dartus](https://github.com/medartus).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmedartus%2Furl-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmedartus%2Furl-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmedartus%2Furl-preview/lists"}