https://github.com/ssbarbee/app-store-ratings
🌟 Wrapper that let you fetch ratings for your IOS APP. Written in Typescript.
https://github.com/ssbarbee/app-store-ratings
app-store integration ios nodejs ratings typescript
Last synced: 5 months ago
JSON representation
🌟 Wrapper that let you fetch ratings for your IOS APP. Written in Typescript.
- Host: GitHub
- URL: https://github.com/ssbarbee/app-store-ratings
- Owner: ssbarbee
- License: mit
- Created: 2019-12-15T13:51:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T20:37:23.000Z (over 2 years ago)
- Last Synced: 2025-09-21T02:28:06.935Z (9 months ago)
- Topics: app-store, integration, ios, nodejs, ratings, typescript
- Language: TypeScript
- Homepage:
- Size: 225 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
| Statements | Branches | Functions | Lines |
| --------------------------- | ----------------------- | ------------------------- | ----------------- |
|  |  |  |  |
# app-store-ratings 🌟
Ever had the need to fetch ratings for your IOS App using node? Tired of deducing the types returned by the App Store API? Then ```app-store-ratings``` is what you're looking for!
# Description 📚
Simple wrapper that let you fetch ratings for your IOS APP. Written in `Typescript`.
# Why? 🧐
There is no well documented API that returns JSON objects for the IOS App ratings. There is an endpoint that returns XML or JSON.
The API that returns XML contains more data than the one that returns JSON. Converting from XML to JSON on several
projects got a bit tedious. And voilà the package was born.
# Installation 📦
## npm
```npm install app-store-ratings```
## yarn
```yarn add app-store-ratings```
# Usage 🚀
No extensive tutorials required. Learn by example.
# Examples
## Classic promise
```typescript
import { fetchRatings } from 'app-store-ratings';
function getRatings() {
fetchRatings({
projectId: 'XXX', // the IOS App projectId
country: 'YYY' // Optional country if your app is available across many stores
})
.then(ratings => console.log(ratings));
}
```
## Async await
```typescript
import { fetchRatings } from 'app-store-ratings';
async function getRatings() {
const ratings = await fetchRatings({
projectId: 'XXX', // the IOS App projectId
country: 'YYY' // Optional country if your app is available across many stores
});
console.log(ratings);
}
```
# Entry type
```typescript
export interface IAppStoreRating {
id: string;
title: string;
updatedAt: string;
content: string;
rating: number;
voteCount: number;
voteSum: number;
version: string;
author: {
name: string;
uri: string;
};
}
```