Skip to content

Update README with method and argument details #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ma-tecik wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with method and argument details #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,25 @@ The general API call looks like
```python
api.<methodName>(<args>)
```
### Some methods
| Method Name | args | Description |
|-|-|-|
| titleHomeMainV2 | titleNo= | Returns info for an original series |
| challengeTitleHomeMainV1 | titleNo= | Returns info for a canvas |
| promotionInfo | | Returns promotions |
| getRetentionTitleInfo | IDK | IDK |
| titleHomeMainRealTimeV2 | IDK | IDK |
| titleRulesetV1 | IDK | IDK |
| episodeListRecommendTab | IDK | IDK |
| customPageEvent | IDK | IDK |

#### General args
| args | values | Is required? | notes |
|-|-|-|-|
| platform | "APP_ANDROID" or "APP_IPHONE" | yes | |
| serviceZone | "Global" | no | |
| language | "en" | yes | IDK why but I couldn't make it work for any other language, will try later |


# Installation

Expand All @@ -50,4 +69,4 @@ See [API.md](docs/API.md) in docs.

# How we got here

If you are interested in how this library was created, have a look at [Reverse-engineering.md](docs/Reverse-engineering.md) in docs
If you are interested in how this library was created, have a look at [Reverse-engineering.md](docs/Reverse-engineering.md) in docs