Skip to main content

An asynchronous wrapper for the Pretend API.

Project description

# PretendAPI

PretendAPI is an asynchronous wrapper for the Pretend API, designed to simplify 
the process of fetching user information from the official Pretend API.

## Features

- Asynchronous requests using `aiohttp`
- Dot notation access to JSON responses
- Rate limiting support
- Handles exceptions gracefully

## Installation

You can install the package via pip:

```bash
pip install pretendapi

Methods

get_userinfo(user_id: int)

Fetches user information about a Discord user.

  • Parameters:
    • user_id (int): The user ID of the user.
  • Returns: User information with dot notation access.

get_tiktok_user(username: str)

Fetches information about a TikTok user.

  • Parameters:
    • username (str): The TikTok username.
  • Returns: TikTok user information with dot notation access.

get_instagram_user(username: str)

Fetches information about an Instagram user.

  • Parameters:
    • username (str): The Instagram username.
  • Returns: Instagram user information with dot notation access.

get_twitter_user(username: str)

Fetches information about a Twitter user.

  • Parameters:
    • username (str): The Twitter username.
  • Returns: Twitter user information with dot notation access.

get_roblox_user(username: str)

Fetches information about a Roblox user.

  • Parameters:
    • username (str): The Roblox username.
  • Returns: Roblox user information with dot notation access.

get_signed_biolink(username: str)

Fetches information about a signed.bio user.

  • Parameters:
    • username (str): The signed.bio username.
  • Returns: signed.bio user information with dot notation access.

Usage

Here's a basic example of how to use the PretendAPI:

import asyncio
from pretend_api import PretendAPI

async def main():
    api_wrapper = PretendAPI(api_key="YOUR_API_KEY")
    
    
    user_info = await api_wrapper.get_userinfo(user_id=123456789)
    
    
    print(user_info.username)  

asyncio.run(main())

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pretendapi-0.1.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pretendapi-0.1.2-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file pretendapi-0.1.2.tar.gz.

File metadata

  • Download URL: pretendapi-0.1.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pretendapi-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7a7d5441fb552493ccf62be05ea2696659596935b3a835dea04b08fe8aaa028a
MD5 3be1df2e31bcf6a653356ef9524a19fb
BLAKE2b-256 064a70111e6bd4436d68fa4fb52cca379754d5457440e38b46b742e7e265cfe2

See more details on using hashes here.

File details

Details for the file pretendapi-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pretendapi-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pretendapi-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4f5ff4d484584c1d3492cce9d2e5a7176715d4721bd030594cb1f355a0cf163d
MD5 a9cd0888d4e39d14c00534e97a4cbce8
BLAKE2b-256 1a47bfb3514259c7372f39e3b09e89a388a308e1716e4e3d3faf0ec413b605e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page