{"id":23757551,"url":"https://github.com/scientanl/brandr-api","last_synced_at":"2025-10-20T05:40:34.650Z","repository":{"id":38974794,"uuid":"178360036","full_name":"ScientaNL/brandr-api","owner":"ScientaNL","description":"logo and style extractor api","archived":false,"fork":false,"pushed_at":"2024-08-19T12:21:09.000Z","size":1325,"stargazers_count":21,"open_issues_count":18,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-08-19T14:22:58.597Z","etag":null,"topics":["api","logo","nodejs"],"latest_commit_sha":null,"homepage":"https://brandr.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScientaNL.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}},"created_at":"2019-03-29T08:02:02.000Z","updated_at":"2024-08-19T12:20:45.000Z","dependencies_parsed_at":"2022-09-19T16:52:59.836Z","dependency_job_id":"be49243a-35c8-4e76-ae38-7fad78463b3a","html_url":"https://github.com/ScientaNL/brandr-api","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScientaNL%2Fbrandr-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScientaNL%2Fbrandr-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScientaNL%2Fbrandr-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScientaNL%2Fbrandr-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScientaNL","download_url":"https://codeload.github.com/ScientaNL/brandr-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232024701,"owners_count":18461966,"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","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":["api","logo","nodejs"],"created_at":"2024-12-31T19:48:48.591Z","updated_at":"2025-10-08T03:28:51.422Z","avatar_url":"https://github.com/ScientaNL.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BRANDr API\nBRANDr is an API which retrieves the logos and branding colors of a website. You can use it to obtain branding information of a website based on a URL.\n\nThe project utilizes [Puppeteer](https://github.com/GoogleChrome/puppeteer) in order to load a website and perform strategies to assert what the logo and branding colors of a website could be. There are various strategies deployed:\n- DOM parsing\n- Meta parsing\n- Social data parsing\n- Color usage parsing\n\n\n## Deploying the BRANDr API\nCheckout the repository, create your own `.env` file (the defaults should be fine) and deploy the BRANDr API Docker container using `docker-compose`:\n\n```shell\ndocker-compose -f docker-compose.yml up -d --force-recreate \\\n  \u0026\u0026 docker-compose -f docker-compose.yml logs -f\n```\n\nThis command uses `docker logs` to monitor the container usage and debug information.\n\n\n## Using the API\nCheck out the API with your favorite REST request tool, such as Postman.\n\n\n### Request\nFire a x-form-urlencoded POST request to BRANDr endpoint\n\n| Item        | Value                             |\n|-------------|-----------------------------------|\n| Endpoint    | *endpoint specified in .env file* |\n| Method      | POST                              |\n| Body        | x-form-urlencoded form parameters |\n|  - endpoint | `\u003c\u003cwebsite URL to retrieve\u003e\u003e`     |\n\n\n### Response\nA response could like the result displayed below. The logo array contains our guess. The other properties are the best guesses for their respective strategy.\n\n```json\n{\n    \"uri\": \"https://www.scienta.nl\",\n    \"extractions\": {\n        \"logo\": [\n            \"\u003c\u003chost\u003e\u003e/520582509e2936254f0bb430d0da3a46.png\",\n            \"\u003c\u003chost\u003e\u003e/aadc84c2b34d58618564d8ab721f8f7d.jpg\",\n            \"\u003c\u003chost\u003e\u003e/39766a4fd1f3d8149ea1f266c8a8a996.png\"\n        ],\n        \"dom-logo\": \"\u003c\u003chost\u003e\u003e/520582509e2936254f0bb430d0da3a46.png\",\n        \"social-logo\": \"\u003c\u003chost\u003e\u003e/aadc84c2b34d58618564d8ab721f8f7d.jpg\",\n        \"meta-logo\": \"\u003c\u003chost\u003e\u003e/6816a7546d517431aa9d5894f27c0c42.png\",\n        \"site-style\": [\n            {\n                \"colors\": [\n                    \"rgb(230, 81, 0)\"\n                ],\n                \"grays\": [\n                    \"rgb(51, 51, 51)\",\n                    \"rgb(0, 0, 0)\"\n                ]\n            }\n        ]\n    }\n}\n```\n\n\n## Contributing\nFor an effortless local development setup, execute the command below:\n\n```shell\ncd app \u0026\u0026 \\\nnpm install \u0026\u0026 \\\ndocker-compose -f docker-compose.local.yml up -d --force-recreate \u0026\u0026 \\\ndocker-compose -f docker-compose.local.yml logs -f\n```\n\nThank you for your interest in contributing to the BRANDr API!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscientanl%2Fbrandr-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscientanl%2Fbrandr-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscientanl%2Fbrandr-api/lists"}