Metadata-Version: 2.1
Name: HQApi
Version: 1.5.0
Summary: HQ Trivia API
Home-page: https://github.com/katant/HQApi
Author: Katant
Author-email: katant.savelev@yandex.ru
License: UNKNOWN
Description: # HQApi
        HQ Trivia & Words API, written in Python
        
        ## Installation
        1. Install from pip (may be outdated):
        ```bash
        pip3 install HQApi
        ```
        
        2. Install from sources:
        ```bash
        git clone https://github.com/katant/HQApi.git
        cd HQApi
        python3 setup.py install
        ```
        
        ## Usage
        Example code to get next US show game:
        ```python
        from HQApi import HQApi
        
        bearer = "Bearer"
        api = HQApi(bearer)
        
        print(str(api.get_show()))
        ```
        
        ## HQApi Methods
        | Method             | Description                                       |
        |--------------------|---------------------------------------------------|
        | `get_users_me`     | Information about your account                    |
        | `get_user`         | Information about account by ID                   |
        | `get_payouts_me`   | Information about payouts                         |
        | `get_show`         | Information about next show                       |
        | `easter_egg`       | Easter egg, gives 1 life once a week              |
        | `make_payout`      | Makes payout to your paypal (Can't bypass ban)    |
        | `send_code`        | Send sms or call to number                        |
        | `confirm_code`     | Confirm received sms                              |
        | `register`         | Register account                                  |
        | `aws_credentials`  | Get credentials                                   |
        | `delete_avatar`    | Delete avatar                                     |
        | `add_friend`       | Add friend                                        |
        | `friend_status`    | Get friend status                                 |
        | `remove_friend`    | Delete friend                                     |
        | `accept_friend`    | Accept friend                                     |
        | `check_username`   | Check username availability                       |
        | `custom`           | Custom request                                    |
        
        ## HQWebsocket Methods
        | Method             | Description        |
        |--------------------|--------------------|
        | `get`              | Return websocket   |
        | `close`            | Close websocket    |
        | `send_json`        | Send custom json   |
        | `send_answer`      | Send answer        |
        | `send_life`        | Send life          |
        | `send_comment`     | Send comment       |
        | `send_letter`      | Send letter        |
        | `send_wheel`       | Send wheel letter  |
        
        ## Regions
        | Region | Description           |
        |--------|-----------------------|
        | `1`    | US, United States     |
        | `2`    | ~~UK, Great Britain~~ |
        | `3`    | ~~DE, Germany~~       |
        | `4`    | ~~AU, Australia~~     |
        
        ## Headers
        | Headers | Description           |
        |---------|-----------------------|
        | `1`     | Android headers       |
        | `2`     | iOS headers           |
        
        ##Examples
        
        | Example             | Description                                                                                    |
        |---------------------|------------------------------------------------------------------------------------------------|
        | `get_show.py`       | [Get next show](https://github.com/katant/HQApi/blob/master/examples/get_show.py)              |
        | `life_bot.py`       | [Life bot to generate lifes](https://github.com/katant/HQApi/blob/master/examples/life_bot.py) |
        | `register_login.py` | [Login or register](https://github.com/katant/HQApi/blob/master/examples/register_login.py)    |
        | `websocket.py`      | [Work with websocket](https://github.com/katant/HQApi/blob/master/examples/websocket.py)       |
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
