{"id":48979583,"url":"https://github.com/yukidaruma/splatoon-stats-api","last_synced_at":"2026-04-18T10:45:17.914Z","repository":{"id":37174279,"uuid":"185815650","full_name":"yukidaruma/splatoon-stats-api","owner":"yukidaruma","description":"The API used by https://splatoon-stats.yuki.games","archived":false,"fork":false,"pushed_at":"2023-01-11T03:43:37.000Z","size":3072,"stargazers_count":5,"open_issues_count":19,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-04T09:18:08.551Z","etag":null,"topics":["splatoon","splatoon2"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/yukidaruma.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}},"created_at":"2019-05-09T14:29:43.000Z","updated_at":"2022-10-12T11:49:22.000Z","dependencies_parsed_at":"2023-02-09T01:01:39.519Z","dependency_job_id":null,"html_url":"https://github.com/yukidaruma/splatoon-stats-api","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/yukidaruma/splatoon-stats-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yukidaruma%2Fsplatoon-stats-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yukidaruma%2Fsplatoon-stats-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yukidaruma%2Fsplatoon-stats-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yukidaruma%2Fsplatoon-stats-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yukidaruma","download_url":"https://codeload.github.com/yukidaruma/splatoon-stats-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yukidaruma%2Fsplatoon-stats-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"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":["splatoon","splatoon2"],"created_at":"2026-04-18T10:45:17.225Z","updated_at":"2026-04-18T10:45:17.905Z","avatar_url":"https://github.com/yukidaruma.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# splatoon-stats-api\n\n## Overview\n\n- This project provides API used by [splatoon-stats-web](https://github.com/yukidaruma/splatoon-stats-web).\n- The app is available online at [https://splatoon-stats.yuki.games](https://splatoon-stats.yuki.games).\n- Updates are available on Twitter [@SplatoonStats](https://twitter.com/SplatoonStats).\n\nThis program fetches\n\n- League Ranking every 2 hours.\n- Splatfest schedules every day. If there's unfetched splatfest rankings, fetch them too.\n- X Ranking at every first day of the month.\n\n## Install\n\n```sh\ngit clone https://github.com/yukidaruma/splatoon-stats-api.git\ncd splatoon-stats-api\nnpm install\ndocker-compose build\n```\n\n## Start\n\n```sh\ndocker-compose up postgres -d\n\n# Install pm2 if not installed.\nnpm install -g pm2\npm2 start npm --name splatoon-stats -- run start\n\n# You can use these commands as soon as PM2 daemon has started\npm2 logs\npm2 stop spatoon-stats\n```\n\nYou need to run following setup commands before first run.\n\n```sh\ncat \u003c\u003c EOF \u003e .env # Create .env file to override settings in config.js\nIKSM_SESSION=\u003cyour iksm session\u003e\nEOF\nnpm run setup\n\n\n# Optional steps:\n# Note these 2 commands has long interval between fetching.\n# It's recommended to use screen/tmux to run these tasks in background.\n\n# Run if you want past league rankings. By default, it will fetch all league rankings since 2018-01-01.\nnpm run fetch-league-rankings\n\n# Run if you want past x rankings. By default, it will fetch all x rankings since 2018-05.\nnpm run fetch-x-rankings\n```\n\n## Third-party APIs\n\nThis app is using following third-party APIs.\n\n- [Spatoon2.ink API](https://github.com/misenhower/splatoon2.ink/wiki/Data-access-policy) by [@mattisenhower](https://twitter.com/mattisenhower) for images, locales and future stage rotations.\n- [Spla2 API](https://spla2.yuu26.com/) by [@m_on_yu](https://twitter.com/m_on_yu) for past league battle stage rotations.\n- [Stat.ink API](https://github.com/fetus-hina/stat.ink/tree/master/doc/api-2) by [@fetus_hina](https://twitter.com/fetus_hina) for weapon names.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyukidaruma%2Fsplatoon-stats-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyukidaruma%2Fsplatoon-stats-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyukidaruma%2Fsplatoon-stats-api/lists"}