Metadata-Version: 2.1
Name: api-geoguessr
Version: 1.0.0
Summary: An asynchronous API integrator for Geoguessr
Project-URL: Homepage, https://github.com/toinoublz/geoguessr-api
Author-email: Antoine BLAISE <antoine.blaise34@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: requests>=2.26.0
Description-Content-Type: text/markdown

This is a Geoguessr API client written in Python. It allows you to interact with the Geoguessr API, such as getting information about users, challenges, maps, and scores.

To install the package, run the following command:

```
pip install geoguessr-api
```

Once the package is installed, you can create a client object by passing your NCFA cookie to the constructor:

```Python
from geoguessr_async import Geoguessr

client = Geoguessr("your_ncfa_cookie")
```

*To get your NCFA cookie, login to geoguessr, open your dev tools (`Ctrl+Shift+I`), go to Storage/Cookies and copy the value of `_ncfa`.*

You can then use the client object to get information about users, challenges, maps, and scores. For example, to get information about an user with his ID, you can use the following code:

```Python
user = client.get_user_infos(userId)
```

The `Profile` object will contain information such as your username, country, and number of games played.

To get information about a challenge, you can use the following code:

```Python
challenge = client.get_challenge_infos("https://geoguessr.com/challenge/xxxx")
```

The `Challenge` object will contain information such as the challenge name, description, and time limit.

To get information about a map, you can use the following code:

```Python
map = client.get_map_infos("https://geoguessr.com/maps/xxxx")
```

The `Map` object will contain information such as the map name, size, and location.

To get information about a score, you can use the following code:

```Python
score = client.get_challenge_score("https://geoguessr.com/challenge/xxxx")
```

The `Score` object will contain information such as the players' name, score, and time.
*When getting the score of a challenge, it automatically plays it, pinging (0, 0) each round.*

### Example: Get results of a challenge as a list of dictionnaries
```Python
score = client.get_challenge_score("https://geoguessr.com/challenge/xxxx")
scores = []
for s in score:
    d_player = {
        "userId": s.userId,
        "userName":s.playerName,
        "total": s.totalScore,
        "roundPoints": s.gamePlayerGuessesRoundScoreInPoints,
        "roundTimes": s.gamePlayerGuessesTime
    }
    scores.append(d_player)
print(scores)
```

I hope you find this package useful! Please let me know if you have any questions or feedback.