{"id":44442365,"url":"https://github.com/ngo275/app-store-client","last_synced_at":"2026-02-12T14:52:51.792Z","repository":{"id":258882468,"uuid":"875631637","full_name":"ngo275/app-store-client","owner":"ngo275","description":"App Store API client written in TypeScript that allows you to retrieve public information (reviews, ratings, similar apps, and more!) from App Store easily.","archived":false,"fork":false,"pushed_at":"2024-12-04T11:54:17.000Z","size":104,"stargazers_count":15,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-09T21:24:18.731Z","etag":null,"topics":["app-store","app-store-connect","appstore","appstore-api"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/app-store-client","language":"TypeScript","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/ngo275.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":"2024-10-20T13:50:43.000Z","updated_at":"2025-10-02T20:31:24.000Z","dependencies_parsed_at":"2024-10-22T04:17:09.390Z","dependency_job_id":null,"html_url":"https://github.com/ngo275/app-store-client","commit_stats":null,"previous_names":["ngo275/app-store-client"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ngo275/app-store-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngo275%2Fapp-store-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngo275%2Fapp-store-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngo275%2Fapp-store-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngo275%2Fapp-store-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ngo275","download_url":"https://codeload.github.com/ngo275/app-store-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngo275%2Fapp-store-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29369074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["app-store","app-store-connect","appstore","appstore-api"],"created_at":"2026-02-12T14:52:50.222Z","updated_at":"2026-02-12T14:52:51.782Z","avatar_url":"https://github.com/ngo275.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# App Store Client\n\n## What is this?\n\nThis library is a TypeScript library for retrieving public data from the App Store. For example, you can get app details, ratings, reviews, similar apps, and privacy information.\n\nNote that it is different from App Connect API, which focuses on providing API about your app, such as app sales, ratings, reviews, etc.\n\n## Motivation\n\nThis library is inspired by the [app-store-scraper](https://github.com/facundoolano/app-store-scraper) project, which I really appreciate. However, due to recent maintenance issues with the original library, I decided to create this TypeScript version. It includes some breaking changes to enhance TypeScript compatibility and resolve various bugs.\n\n## Features\n\n- 🚀 Full TypeScript support\n- 🔄 Built-in request caching\n- 🛠 Customizable options\n- 📊 Comprehensive API coverage\n- 🧪 Well-tested codebase\n\n## Installation\n\n### NPM\n\n```bash\nnpm install app-store-client\n```\n\n### Yarn\n\n```bash\nyarn add app-store-client\n```\n\n## Usage\n\nFirst, import and instantiate the AppStoreClient:\n\n```typescript\nimport { AppStoreClient, Collection, Country } from \"app-store-client\";\n\nconst client = new AppStoreClient();\n\n// You can customize the country and language by a client instance\n// const client = new AppStoreClient({\n//   country: Country.JP,\n//   language: \"ja\",\n// });\n```\n\n### Get App Details\n\nYou can get app details by ID or bundle ID.\n\n```typescript\n// Use ID\nconst appData = await client.app({ id: \"6446901002\" });\n\n// Or use app ID (bundle ID)\nconst appData = await client.app({ appId: \"com.burbn.barcelona\" });\n\nconsole.log(appData);\n// {\n//   id: '6446901002',\n//   appId: 'com.burbn.barcelona',\n//   title: 'Threads',\n//   url: 'https://apps.apple.com/us/app/threads/id6446901002?uo=4',\n//   description: 'Say more with Threads — Instagram's text-based conversation app.\\n...',\n//   icon: 'https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/60/24/c6/6024c67d-96f2-0977-71de-f5748f72c65f/Prod-0-0-1x_U007emarketing-0-8-0-85-220.png/512x512bb.jpg',\n//   genres: ['Social Networking', 'Entertainment'],\n//   genreIds: ['6005', '6016'],\n//   primaryGenre: 'Social Networking',\n//   primaryGenreId: 6005,\n//   contentRating: '12+',\n//   languages: ['HR', 'CS', 'DA', 'NL', 'EN', '...'],\n//   size: '90769408',\n//   requiredOsVersion: '15.1',\n//   released: '2023-07-05T07:00:00Z',\n//   updated: '2024-11-26T19:20:07Z',\n//   version: '359.1',\n//   price: 0,\n//   currency: 'USD',\n//   free: true,\n//   developerId: '389801255',\n//   developer: 'Instagram, Inc.',\n//   developerUrl: 'https://apps.apple.com/us/developer/instagram-inc/id389801255?uo=4',\n//   score: 4.61366,\n//   reviews: 680654,\n//   currentVersionScore: 4.61366,\n//   currentVersionReviews: 680654,\n//   screenshots: [\n//     'https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/ef/ba/cb/efbacb33-5f14-444f-56bd-d477a44b5464/752f57e3-8a0b-4345-88ad-a0047a922262_iOS_SMALL_2.png/392x696bb.png',\n//     '...'\n//   ],\n//   ipadScreenshots: [],\n//   appletvScreenshots: [],\n//   supportedDevices: [\n//     'iPhone5s-iPhone5s',\n//     'iPadAir-iPadAir',\n//     '...'\n//   ]\n// }\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst appData = await client.app({\n  appId: \"com.burbn.barcelona\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Apps by Developer\n\nYou can get apps by developer ID.\n\n```typescript\n// Use developer ID\nconst apps = await client.appsByDeveloper({ devId: \"389801255\" });\n\nconsole.log(apps);\n// [\n//   {\n//     id: '389801252',\n//     appId: 'com.burbn.instagram',\n//     title: 'Instagram',\n//     url: 'https://apps.apple.com/us/app/instagram/id389801252?uo=4',\n//     description: 'Little moments lead to big friendships. Share yours on Instagram...',\n//     icon: 'https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/97/9e/c4/979ec480-795b-371e-ff57-79d532283364/Prod-0-0-1x_U007ephone-0-1-0-85-220.png/512x512bb.jpg',\n//     genres: ['Photo \u0026 Video', 'Social Networking'],\n//     genreIds: ['6008', '6005'],\n//     primaryGenre: 'Photo \u0026 Video',\n//     primaryGenreId: 6008,\n//     contentRating: '12+',\n//     languages: ['HR', 'CS', 'DA', 'NL', 'EN', '...'],\n//     size: '365233152',\n//     requiredOsVersion: '15.1',\n//     released: '2010-10-06T08:12:41Z',\n//     updated: '2024-11-26T15:14:17Z',\n//     version: '359.0.0',\n//     price: 0,\n//     currency: 'USD',\n//     free: true,\n//     developerId: '389801255',\n//     developer: 'Instagram, Inc.',\n//     developerUrl: 'https://apps.apple.com/us/developer/instagram-inc/id389801255?uo=4',\n//     score: 4.70782,\n//     reviews: 27066795,\n//     currentVersionScore: 4.70782,\n//     currentVersionReviews: 27066795,\n//     screenshots: ['...'],\n//     ipadScreenshots: [],\n//     appletvScreenshots: [],\n//     supportedDevices: ['...']\n//   },\n//   // ... more apps\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst apps = await client.appsByDeveloper({\n  devId: \"389801255\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### List Apps\n\nYou can list apps by collection name. Please see the `Collection` enum for available collections.\n\n```typescript\n// Use collection name\nconst topFreeApps = await client.list({\n  collection: Collection.TOP_FREE_IOS,\n  num: 5,\n});\n\nconsole.log(topFreeApps);\n// [\n//   {\n//     id: '6446901002',\n//     appId: 'com.burbn.barcelona',\n//     title: 'Threads',\n//     url: 'https://apps.apple.com/us/app/threads/id6446901002?uo=2',\n//     description: 'Say more with Threads — Instagram's text-based conversation app...',\n//     icon: 'https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/60/24/c6/6024c67d-96f2-0977-71de-f5748f72c65f/Prod-0-0-1x_U007emarketing-0-8-0-85-220.png/100x100bb.png',\n//     genres: ['Social Networking'],\n//     genreIds: ['6005'],\n//     primaryGenre: 'Social Networking',\n//     primaryGenreId: '6005',\n//     contentRating: 'Application',\n//     languages: [],\n//     size: '',\n//     requiredOsVersion: '',\n//     released: 'July 5, 2023',\n//     updated: 'July 5, 2023',\n//     version: '',\n//     price: '0.00',\n//     currency: 'USD',\n//     free: true,\n//     developerId: '389801255',\n//     developer: 'Instagram, Inc.',\n//     developerUrl: 'https://apps.apple.com/us/developer/instagram-inc/id389801255?uo=2',\n//     score: 0,\n//     reviews: 0,\n//     currentVersionScore: 0,\n//     currentVersionReviews: 0,\n//     screenshots: ['...'],\n//     ipadScreenshots: [],\n//     appletvScreenshots: [],\n//     supportedDevices: []\n//   }\n//   // ... more apps\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst topFreeApps = await client.list({\n  collection: Collection.TOP_FREE_IOS,\n  num: 5,\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Privacy Details\n\nYou can get privacy details by ID. You must provide the ID.\n\n```typescript\nconst privacy = await client.privacy({ id: \"6446901002\" });\n\nconsole.log({\n  managePrivacyChoicesUrl: null,\n  privacyTypes: [\n    {\n      privacyType: \"Data Linked to You\",\n      identifier: \"DATA_LINKED_TO_YOU\",\n      description:\n        \"The following data, which may be collected and linked to your identity, may be used for the following purposes:\",\n      purposes: [\n        {\n          purpose: \"Third-Party Advertising\",\n          identifier: \"THIRD_PARTY_ADVERTISING\",\n          dataCategories: [\n            {\n              dataCategory: \"Purchases\",\n              identifier: \"PURCHASES\",\n              dataTypes: [\"Purchase History\"],\n            },\n            {\n              dataCategory: \"Location\",\n              identifier: \"LOCATION\",\n              dataTypes: [\"Precise Location\", \"Coarse Location\"],\n            },\n            // ... more data categories\n          ],\n        },\n        {\n          purpose: \"Analytics\",\n          identifier: \"ANALYTICS\",\n          dataCategories: [\n            {\n              dataCategory: \"Usage Data\",\n              identifier: \"USAGE_DATA\",\n              dataTypes: [\"Product Interaction\", \"Advertising Data\"],\n            },\n            // ... more data categories\n          ],\n        },\n        // ... more purposes\n      ],\n    },\n  ],\n});\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst privacy = await client.privacy({\n  id: \"6446901002\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Ratings\n\nYou can get ratings by ID. You must provide the ID.\n\n```typescript\nconst ratings = await client.ratings({ id: \"6446901002\" });\n\nconsole.log(JSON.stringify(ratings, null, 2));\n// Output:\n// {\n//   \"ratings\": 680654,\n//   \"histogram\": {\n//     \"1\": 32878,\n//     \"2\": 9794,\n//     \"3\": 25216,\n//     \"4\": 51641,\n//     \"5\": 561125\n//   }\n// }\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst ratings = await client.ratings({\n  id: \"6446901002\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Reviews\n\nYou can get reviews by ID or app ID (bundle ID). You must provide either ID or app ID.\n\n```typescript\n// Use ID\nconst reviews = await client.reviews({ id: \"6446901002\" });\n\n// Or use app ID (bundle ID)\nconst reviews = await client.reviews({ appId: \"com.burbn.barcelona\" });\n\nconsole.log(reviews);\n// [\n//   {\n//     \"id\": \"12012163673\",\n//     \"userName\": \"Moms deepen\",\n//     \"userUrl\": \"https://itunes.apple.com/us/reviews/id1727492095\",\n//     \"version\": \"359.1\",\n//     \"score\": 5,\n//     \"title\": \"So lucky\",\n//     \"text\": \"When u home\",\n//     \"url\": \"https://itunes.apple.com/us/review?id=6446901002\u0026type=Purple%20Software\",\n//     \"updated\": \"2024-11-30T22:47:31-07:00\"\n//   },\n//   // ... more reviews\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst reviews = await client.reviews({\n  appId: \"com.burbn.barcelona\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Search Apps\n\nYou can search apps by keyword.\n\n```typescript\nconst searchResults = await client.search({ term: \"chatgpt\", num: 5 });\n\nconsole.log(searchResults);\n// [\n//   {\n//     \"id\": \"6447763703\",\n//     \"appId\": \"genius.chat\",\n//     \"title\": \"ChatBox - AI Chat with Chatbot\",\n//     \"url\": \"https://apps.apple.com/us/app/chatbox-ai-chat-with-chatbot/id6447763703\",\n//     \"description\": \"Meet ChatBox, your loyal AI chatbot powered by the advanced ChatGPT and GPT-4o models...\",\n//     \"icon\": \"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/9d/40/70/9d407045-ccd8-7672-e208-3f4100cfdbde/AppIcon-0-0-1x_U007ephone-0-0-0-1-0-0-sRGB-85-220.png/512x512bb.jpg\",\n//     \"genres\": [\"Productivity\", \"Utilities\"],\n//     \"genreIds\": [\"6007\", \"6002\"],\n//     \"primaryGenre\": \"Productivity\",\n//     \"primaryGenreId\": 6007,\n//     \"contentRating\": \"12+\",\n//     \"languages\": [\"EN\", \"FR\", \"DE\", \"IT\", \"JA\", \"KO\", \"ZH\", \"ES\"],\n//     \"size\": \"105195520\",\n//     \"requiredOsVersion\": \"16.0\",\n//     \"released\": \"2023-04-21T07:00:00Z\",\n//     \"updated\": \"2024-11-26T15:30:17Z\",\n//     \"version\": \"1.49\",\n//     \"price\": 0,\n//     \"currency\": \"USD\",\n//     \"free\": true,\n//     \"developer\": \"FLORATE LIMITED\",\n//     \"developerUrl\": \"https://apps.apple.com/us/developer/florate-limited/id1682503272\",\n//     \"score\": 4.65819,\n//     \"reviews\": 130542,\n//     \"currentVersionScore\": 4.65819,\n//     \"currentVersionReviews\": 130542\n//   },\n//   // ... more results\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst searchResults = await client.search({\n  term: \"chatgpt\",\n  num: 5,\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Similar Apps\n\nYou can get similar apps by ID or app ID (bundle ID). You must provide either ID or app ID.\n\n```typescript\n// Use ID\nconst similarApps = await client.similarApps({ id: \"6446901002\" });\n\n// Or use app ID (bundle ID)\nconst similarApps = await client.similarApps({ appId: \"com.burbn.barcelona\" });\n\nconsole.log(similarApps);\n// [\n//   {\n//     \"id\": \"6444370199\",\n//     \"appId\": \"xyz.blueskyweb.app\",\n//     \"title\": \"Bluesky Social\",\n//     \"url\": \"https://apps.apple.com/us/app/bluesky-social/id6444370199?uo=4\",\n//     \"description\": \"Bluesky is THE NEW SOCIAL NETWORK for people who stay online and up-to-date...\",\n//     \"icon\": \"https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/cb/3b/73/cb3b73c7-02b4-11a1-2f1f-0721d1af5c14/AppIcon-0-0-1x_U007ephone-0-85-220.png/512x512bb.jpg\",\n//     \"genres\": [\"Social Networking\", \"Entertainment\"],\n//     \"genreIds\": [\"6005\", \"6016\"],\n//     \"primaryGenre\": \"Social Networking\",\n//     \"primaryGenreId\": 6005,\n//     \"contentRating\": \"17+\",\n//     \"languages\": [\"EN\", \"FR\", \"DE\", \"IT\", \"JA\", \"KO\", \"ZH\", \"ES\"],\n//     \"size\": \"45962240\",\n//     \"requiredOsVersion\": \"15.1\",\n//     \"released\": \"2023-02-18T08:00:00Z\",\n//     \"updated\": \"2024-11-27T18:50:41Z\",\n//     \"version\": \"1.95\",\n//     \"price\": 0,\n//     \"currency\": \"USD\",\n//     \"free\": true,\n//     \"developer\": \"Bluesky PBLLC\",\n//     \"developerUrl\": \"https://apps.apple.com/us/developer/bluesky-pbllc/id1654243552?uo=4\",\n//     \"score\": 4.26304,\n//     \"reviews\": 6364,\n//     \"currentVersionScore\": 4.26304,\n//     \"currentVersionReviews\": 6364\n//     \"screenshots\": [\"...\"],\n//     \"ipadScreenshots\": [\"...\"],\n//     \"appletvScreenshots\": [\"...\"],\n//     \"supportedDevices\": [\"...\"]\n//   },\n//   // ... more similar apps\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst similarApps = await client.similarApps({\n  appId: \"com.burbn.barcelona\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Get Suggested Search Terms\n\nYou can get suggested search terms by keyword.\n\n```typescript\nconst suggestions = await client.suggestedTerms({ term: \"threads\" });\n\nconsole.log(suggestions);\n// [\n//   {\n//     \"term\": \"threads\"\n//   },\n//   {\n//     \"term\": \"threads app\"\n//   },\n//   // ... more suggestions\n// ]\n```\n\nYou can also customize the country and language by a function parameter.\n\n```typescript\nconst suggestions = await client.suggestedTerms({\n  term: \"threads\",\n  country: Country.JP,\n  language: \"ja\",\n});\n```\n\n### Caching\n\nThe client includes built-in request caching. You can customize the cache max age when instantiating the client:\n\n```typescript\nconst client = new AppStoreClient({ cacheMaxAge: 1000 * 60 * 5 }); // 5 minutes\n```\n\nThis helps reduce unnecessary API calls and improve performance for repeated requests. If the request body or parameters are different, it will be treated as a different request.\n\nThe default cache max age is 5 minutes and up to 1000 requests.\n\n### Custom Request Options\n\n```typescript\nexport interface AppStoreClientOptions {\n  country?: Country;\n  language?: string;\n  requestOptions?: any;\n  throttle?: number;\n  cacheMaxAge?: number;\n  cacheMaxSize?: number;\n}\n```\n\n- `country`: The country to use. Defaults to `Country.US`. You can find the list of available countries [here](https://github.com/ngo275/app-store-client/blob/master/src/constants.ts).\n- `language`: The language to use. Defaults to `en-us`.\n- `requestOptions`: The request options to use.\n- `throttle`: The throttle to use. Defaults to undefined.\n- `cacheMaxAge`: The cache max age. Defaults to `1000 * 60 * 5` ms (5 minutes).\n- `cacheMaxSize`: The cache max size. Defaults to `1000`.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngo275%2Fapp-store-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fngo275%2Fapp-store-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngo275%2Fapp-store-client/lists"}