{"id":18109577,"url":"https://github.com/alfg/overwatch-api","last_synced_at":"2025-05-16T09:05:00.555Z","repository":{"id":10874170,"uuid":"67324415","full_name":"alfg/overwatch-api","owner":"alfg","description":":earth_americas: An Unofficial Overwatch HTTP API","archived":false,"fork":false,"pushed_at":"2025-01-13T07:34:02.000Z","size":1026,"stargazers_count":148,"open_issues_count":2,"forks_count":26,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-12T06:06:11.769Z","etag":null,"topics":["api","blizzard","esports","overwatch","overwatch-api"],"latest_commit_sha":null,"homepage":"","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/alfg.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":"2016-09-04T03:51:53.000Z","updated_at":"2025-01-13T07:34:06.000Z","dependencies_parsed_at":"2024-06-18T21:30:01.454Z","dependency_job_id":"ea9caaf8-433b-4ea3-a90c-173026e5e3dd","html_url":"https://github.com/alfg/overwatch-api","commit_stats":{"total_commits":207,"total_committers":14,"mean_commits":"14.785714285714286","dds":0.3285024154589372,"last_synced_commit":"e9435cdf113c277ee8efe025392f41c50d88c05e"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Foverwatch-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Foverwatch-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Foverwatch-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Foverwatch-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alfg","download_url":"https://codeload.github.com/alfg/overwatch-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254120462,"owners_count":22017997,"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","blizzard","esports","overwatch","overwatch-api"],"created_at":"2024-11-01T00:01:51.882Z","updated_at":"2025-05-16T09:04:55.541Z","avatar_url":"https://github.com/alfg.png","language":"JavaScript","funding_links":[],"categories":["Community"],"sub_categories":["Github"],"readme":"# Overwatch API\nAn unofficial [Overwatch](https://playoverwatch.com) and [Overwatch League](https://overwatchleague.com) HTTP API and NodeJS module.\n\n\u003cp align=center\u003e\u003cimg src=\"overwatch.jpg\"\u003e\u003c/img\u003e\u003c/p\u003e\n\n[![npm](https://img.shields.io/npm/v/overwatch-api.svg)](https://www.npmjs.com/package/overwatch-api)\n[![Build Status](https://travis-ci.org/alfg/overwatch-api.svg?branch=master)](https://travis-ci.org/alfg/overwatch-api)\n\n## Features\n* Profile Data*\n* Career Stats*\n* Overwatch League Data\n  * Live Match\n  * Standings\n  * Schedule\n\n**Please note, as of the JUNE 26, 2018 patch, Career Profiles will no longer be public by default (now defaults to Friends Only). An option to make Career Profiles visible has been added under Options \u003e Social \u003e Profile Visibility. \n\nYour profile *MUST* be public to view most profile and career stats with this API.\n\nSource: https://playoverwatch.com/en-us/news/patch-notes/pc#patch-47946\n\n## API Docs\nSee: http://localhost:3000/docs/\n\n## NPM Module\nIf you wish to use the Javascript API in your own project, see [api/README.md](api/README.md).\n\n## Demo\n\n```\ncurl http://localhost:3000/profile/pc/us/Jay3-11894\n```\n```json\n{\n  \"username\": \"Jay3\",\n  \"level\": 2970,\n  \"portrait\": \"https://d15f34w2p8l1cc.cloudfront.net/overwatch/190aa6150e33690e39a9c91308d5da9b2e262262657af26579b95e939c44d5ad.png\",\n  \"endorsement\": {\n    \"sportsmanship\": {\n      \"value\": 0.18,\n      \"rate\": 18\n    },\n    \"shotcaller\": {\n      \"value\": 0.44,\n      \"rate\": 44\n    },\n    \"teammate\": {\n      \"value\": 0.38,\n      \"rate\": 38\n    },\n    \"level\": null,\n    \"frame\": \"https://static.playoverwatch.com/svg/icons/endorsement-frames-3c9292c49d.svg#_2\",\n    \"icon\": \"data:image/svg+xml;base64,PHN2ZyBoZWlnaHQ9IjQwIiB3aWR0aD0iNDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxjaXJjbGUgcj0iMTUuOTE1NDk0MzA5MTg5NTQiIGZpbGw9IiMyYTJiMmUiIHN0cm9rZS1kYXNoYXJyYXk9IjQ0IDU2IiBzdHJva2UtZGFzaG9mZnNldD0iMjUiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlPSIjZjE5NTEyIiBjeD0iNTAlIiBjeT0iNTAlIj48L2NpcmNsZT48Y2lyY2xlIHI9IjE1LjkxNTQ5NDMwOTE4OTU0IiBmaWxsPSJ0cmFuc3BhcmVudCIgc3Ryb2tlLWRhc2hhcnJheT0iMzggNjIiIHN0cm9rZS1kYXNob2Zmc2V0PSI4MSIgc3Ryb2tlLXdpZHRoPSIzIiBzdHJva2U9IiNjODFhZjUiIGN4PSI1MCUiIGN5PSI1MCUiPjwvY2lyY2xlPjxjaXJjbGUgcj0iMTUuOTE1NDk0MzA5MTg5NTQiIGZpbGw9InRyYW5zcGFyZW50IiBzdHJva2UtZGFzaGFycmF5PSIxOCA4MiIgc3Ryb2tlLWRhc2hvZmZzZXQ9IjQzIiBzdHJva2Utd2lkdGg9IjMiIHN0cm9rZT0iIzQwY2U0NCIgY3g9IjUwJSIgY3k9IjUwJSI+PC9jaXJjbGU+PHRleHQgeD0iNTAlIiB5PSI1MCUiIGR5PSIuM2VtIiBmb250LWZhbWlseT0iY2VudHVyeSBnb3RoaWMsYXJpYWwsc2Fucy1zZXJpZiIgZm9udC13ZWlnaHQ9IjMwMCIgZm9udC1zaXplPSIxNiIgc3Ryb2tlPSIjZjZmNmY2IiBzdHJva2Utd2lkdGg9IjEiIGZpbGw9IiNmNmY2ZjYiIHRleHQtYW5jaG9yPSJtaWRkbGUiPk5hTjwvdGV4dD48L3N2Zz4=\"\n  },\n  \"private\": false,\n  \"games\": {\n    \"quickplay\": {\n      \"won\": 925,\n      \"played\": 1671\n    },\n    \"competitive\": {\n      \"won\": 145,\n      \"lost\": 121,\n      \"draw\": 4,\n      \"played\": 270,\n      \"win_rate\": 54.51\n    }\n  },\n  \"playtime\": {\n    \"quickplay\": \"201:16:17\",\n    \"competitive\": \"55:14:59\"\n  },\n  \"competitive\": {\n    \"tank\": {\n      \"rank\": null,\n      \"rank_img\": null\n    },\n    \"damage\": {\n      \"rank\": 4553,\n      \"rank_img\": \"https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png\"\n    },\n    \"support\": {\n      \"rank\": null,\n      \"rank_img\": null\n    }\n  },\n  \"levelFrame\": \"https://d15f34w2p8l1cc.cloudfront.net/overwatch/9e8600f97ea4a84d822d8b336f2b1dbfe7372fb9f2b6bf1d0336193567f6f943.png\",\n  \"star\": \"https://d15f34w2p8l1cc.cloudfront.net/overwatch/cd877430ccc400c10e24507dba972e24a4543edc05628045300f1349cf003f3a.png\"\n}\n```\n\n## Install\n\n#### Requirements\n* Node v8.0+\n* Redis\n* Or Docker\n\n```bash\ngit clone https://github.com/alfg/overwatch-api.git\ncd overwatch-api\nnpm install\nnpm start\n```\n\n#### Environment Variables\nSet the following environment variables if you would like to override the default configuration.\n```\nREDIS_URL=redis://localhost:6379\nCACHE_TTL=3600\n```\n\n#### Docker\nA `docker-compose.yml` and `Dockerfile` are provided to easily setup an environment.\n\n```\ndocker-compose build\ndocker-compose up\n```\n\n#### Development\nThis project is built using [srv](https://github.com/alfg/srv), a microservices stack based on [express](https://expressjs.com/). After installation, run the project using the following:\n\n```bash\nnode node_modules/srv-cli/build/srv app/index.js\n```\n\n[nodemon](https://github.com/remy/nodemon) is recommended for auto-reloading during development:\n```bash\nnodemon node_modules/srv-cli/build/srv app/index.js\n```\n\nGenerate docs with the `--docs app/routes` flag.\n\nSee [srv](https://github.com/alfg/srv) documentation for more info on srv specific options.\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfg%2Foverwatch-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falfg%2Foverwatch-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfg%2Foverwatch-api/lists"}