Skip to content

Commit ff08c67

Browse files
committed
Merge branch 'official-api' of https://github.com/RecNetBot-Development/RecNetPy into official-api
2 parents 6ff1b1c + 01382a7 commit ff08c67

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# RecNetPy
2-
> **RecNetPy** is an API wrapper built in Python for pulling data from [RecNet](https://rec.net/). **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!.
2+
> **RecNetPy** is an API wrapper built in Python for pulling data from [RecNet](https://rec.net/). **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!
33
44
[![NPM Version][pip-image]][pip-url]
55
[![Downloads Stats][pip-downloads]][pip-url]
@@ -20,7 +20,7 @@ Creating an instance of RecNetPy:
2020
```py
2121
import recnetpy
2222

23-
RecNet = recnetpy.Client()
23+
RecNet = recnetpy.Client(api_key="...")
2424
```
2525

2626
An example that showcases how to fetch an account by username and acquire its bio:
@@ -30,7 +30,7 @@ import asyncio
3030

3131
async def main():
3232
# Create a new RecNetPy client instance
33-
RecNet = recnetpy.Client()
33+
RecNet = recnetpy.Client(api_key="...")
3434

3535
# Fetch the user from the AccountManager with the "get" method
3636
user = await RecNet.accounts.get("ColinXYZ")
@@ -47,6 +47,11 @@ asyncio.run(main())
4747

4848
_For more examples and usage, please refer to the [``examples``][examples-url]. More documentation can be found [Here][documentation]._
4949

50+
## Authorization
51+
In order to use most of the endpoints, you need an API key. You may acquire one from https://devportal.rec.net/. Endpoints that require an API key are marked in function docstrings.
52+
53+
For more information and guidance, refer to https://recroom.zendesk.com/hc/en-us/articles/16543324225303-Third-Party-API-Access-and-Usage.
54+
5055
## Development setup
5156

5257
To install a local build run the following command.
@@ -79,4 +84,4 @@ _Distributed under the MIT license. See [``LICENSE``][license] for more informat
7984
[readthedocs-url]: https://recnetpy.readthedocs.io/en/latest/?badge=latest
8085
[pip-url]: https://pypi.org/project/pip/
8186
[examples-url]: https://github.com/RecNetBot-Development/RecNetPy/tree/main/examples
82-
[license]: https://github.com/RecNetBot-Development/RecNetPy/blob/main/LICENSE
87+
[license]: https://github.com/RecNetBot-Development/RecNetPy/blob/main/LICENSE

0 commit comments

Comments
 (0)