Installation

pip install git+https://github.com/TheChampu/TheAPI@main

---

API Documentation

This document provides a list of all functions in TheAPI, along with their status and usage examples.

Function List

1. bing_image
2. blackpink
3. carbon
4. cat
5. chatgpt
6. dog
7. fox
8. gen_hashtag
9. get_advice
10. get_hindi_jokes
11. get_jokes
12. get_uselessfact
13. github_search
14. hindi_quote
15. meme
16. morse_code
17. pypi
18. quote
19. randomword
20. stackoverflow_search
21. wikipedia
22. words
23. write

API Status

Function Name	Status
bing_image	✅
blackpink	✅
carbon	✅
cat	✅
chatgpt	❌
dog	✅
fox	✅
gen_hashtag	✅
get_advice	✅
get_hindi_jokes	✅
get_jokes	✅
get_uselessfact	✅
github_search	✅
hindi_quote	✅
meme	✅
morse_code	✅
pypi	✅
quote	✅
randomword	✅
stackoverflow_search	✅
wikipedia	✅
words	✅
write	✅

Code Usage and Results:

bing_image

# Usage:
from TheAPI import api

result = api.bing_image(query='pokemon', limit=3)
print(result)

# Result:
['https://assets1.ignimgs.com/2021/03/25/rayquaza-blogroll-1616713873737.jpg', 'https://staticg.sportskeeda.com/editor/2023/07/0c8e6-16887208209298-1920.jpg', 'https://images.wallpapersden.com/image/download/pokemon-scarlet-and-violet-hd_bW1qamqUmZqaraWkpJRmbmdlrWZlbWU.jpg']

blackpink

# Usage:
from TheAPI import api

result = api.blackpink(args='pokemon', color='#ff94e0', border_color=None)
print(result)

# Result:
https://envs.sh/0Ql.jpg

carbon

# Usage:
from TheAPI import api

result = api.carbon(code='pokemon')
print(result)

# Result:
https://envs.sh/0Qk.png

cat

# Usage:
from TheAPI import api

result = api.cat()
print(result)

# Result:
https://cdn2.thecatapi.com/images/bpZGfNLW1.png

chatgpt

# Usage:
from TheAPI import api

result = api.chatgpt(query='pokemon')
print(result)

# Error:
Expecting value: line 1 column 1 (char 0)

dog

# Usage:
from TheAPI import api

result = api.dog()
print(result)

# Result:
https://random.dog/1ac1c3b2-b1e2-4ad5-9668-95cb8183646b.jpg

fox

# Usage:
from TheAPI import api

result = api.fox()
print(result)

# Result:
https://randomfox.ca/?i=76

gen_hashtag

# Usage:
from TheAPI import api

result = api.gen_hashtag(text='pokemon', similiar=False)
print(result)

# Result:
#pokemon  #pokemongo  #pokemoncards  #pokemontcg  #pokemoncommunity  #pokemonsun  #pokemonsunandmoon  #pokemonmoon  #pokemonxy  #pokemonart  #pokemon20  #pokemonx  #pokemony  #pokemonmemes  #pokemontrainer  #PokemonMaster  #pokemonoras  #pokemonfanart  #pokemonfan  #pokemoncollector  #pokemonred  #pokemonmeme  #pokemoncenter  #pokemonultrasun  #pokemonblue  #pokemoncard  #pokemoncollection  #pokemonultramoon  #pokemoncardsforsale  #pokemoncosplay

get_advice

# Usage:
from TheAPI import api

result = api.get_advice()
print(result)

# Result:
Taking photos with tablet devices looks weird.

get_hindi_jokes

# Usage:
from TheAPI import api

result = api.get_hindi_jokes()
print(result)

# Result:
लोहा लोहे को काटता है, हीरा हीरे को काटता है, आप को भी एक दिन कुत्ता काटेगा, क़योंकि.. कुत्ता किसी को भी काट सकता है|  ...बी पॉज़िटिव यार…. 😆🤣😋😉

get_jokes

# Usage:
from TheAPI import api

result = api.get_jokes(amount=1)
print(result)

# Result:
To whoever stole my copy of Microsoft Office, I will find you. You have my Word!

get_uselessfact

# Usage:
from TheAPI import api

result = api.get_uselessfact()
print(result)

# Result:
No word in the English language rhymes with month, orange, silver and purple.

github_search

# Usage:
from TheAPI import api

result = api.github_search(query='pokemon', search_type='repositories', max_results=3)
print(result)

# Result:
[{'name': 'PokemonGo-Map', 'full_name': 'AHAAAAAAA/PokemonGo-Map', 'description': '🌏 Live visualization of all the pokemon in your area... and more! (shutdown)', 'url': 'https://github.com/AHAAAAAAA/PokemonGo-Map', 'language': None, 'stargazers_count': 7533, 'forks_count': 2819}, {'name': 'pokemon-showdown', 'full_name': 'smogon/pokemon-showdown', 'description': 'Pokémon battle simulator.', 'url': 'https://github.com/smogon/pokemon-showdown', 'language': 'TypeScript', 'stargazers_count': 4734, 'forks_count': 2767}, {'name': 'PokemonGo-Bot', 'full_name': 'PokemonGoF/PokemonGo-Bot', 'description': 'The Pokemon Go Bot, baking with community.', 'url': 'https://github.com/PokemonGoF/PokemonGo-Bot', 'language': 'Python', 'stargazers_count': 3864, 'forks_count': 1540}]

hindi_quote

# Usage:
from TheAPI import api

result = api.hindi_quote()
print(result)

# Result:
कितना भी पकडलो फिसलता ज़रूर है, ये वक्त है जनाब बदलता ज़रूर है।

meme

# Usage:
from TheAPI import api

result = api.meme()
print(result)

# Result:
https://preview.redd.it/ro1r4ssg0lrd1.png?width=640&crop=smart&auto=webp&s=de4f634c99b90e1555f8a58c20e27327ab14caa2

morse_code

# Usage:
from TheAPI import api

result = api.morse_code(txt='pokemon')
print(result)

# Result:
.--. --- -.- . -- --- -.

pypi

# Usage:
from TheAPI import api

result = api.pypi(package_name='pokemon')
print(result)

# Result:
{'name': 'pokemon', 'version': '0.36', 'summary': 'ascii database of pokemon... in Python!', 'author': 'Vanessa Sochat', 'author_email': 'vsoch@noreply.github.users.com', 'license': 'LICENSE', 'home_page': 'https://github.com/vsoch/pokemon', 'package_url': 'https://pypi.org/project/pokemon/', 'requires_python': '', 'keywords': 'pokemon,avatar,ascii,gravatar', 'classifiers': [], 'project_urls': {'Homepage': 'https://github.com/vsoch/pokemon'}}

quote

# Usage:
from TheAPI import api

result = api.quote()
print(result)

# Result:
I know but one freedom and that is the freedom of the mind.

author - Antoine de Saint-Exupéry

randomword

# Usage:
from TheAPI import api

result = api.randomword()
print(result)

# Result:
flinted

stackoverflow_search

# Usage:
from TheAPI import api

result = api.stackoverflow_search(query='pokemon', max_results=3, sort_type='relevance', use_cache=True)
print(result)

# Result:
[{'tags': ['ios', 'flutter', 'dart'], 'owner': {'account_id': 19921816, 'reputation': 3, 'user_id': 14597469, 'user_type': 'registered', 'profile_image': 'https://lh6.googleusercontent.com/-aT6u2l_JT94/AAAAAAAAAAI/AAAAAAAAAAA/AMZuuclcxb94zp_q0Q2R8DQN7b6X3kgo6w/s96-c/photo.jpg?sz=256', 'display_name': 'Senem Sedef', 'link': 'https://stackoverflow.com/users/14597469/senem-sedef'}, 'is_answered': False, 'view_count': 116, 'answer_count': 0, 'score': 0, 'last_activity_date': 1701515081, 'creation_date': 1622231772, 'last_edit_date': 1701515081, 'question_id': 67744802, 'content_license': 'CC BY-SA 4.0', 'link': 'https://stackoverflow.com/questions/67744802/the-getter-pokemon-was-called-on-null-receiver-null-tried-calling-pokemon', 'title': 'The getter 'pokemon' was called on null. Receiver: null Tried calling: pokemon'}, {'tags': ['reactjs', 'random', 'axios'], 'owner': {'account_id': 17931576, 'reputation': 1, 'user_id': 13028884, 'user_type': 'registered', 'profile_image': 'https://www.gravatar.com/avatar/7ebcdd2f784bca5dc54a1a0e17354f86?s=256&d=identicon&r=PG&f=y&so-version=2', 'display_name': 'GieGie', 'link': 'https://stackoverflow.com/users/13028884/giegie'}, 'is_answered': False, 'view_count': 1912, 'answer_count': 2, 'score': 0, 'last_activity_date': 1652730812, 'creation_date': 1642222168, 'last_edit_date': 1642223800, 'question_id': 70718940, 'content_license': 'CC BY-SA 4.0', 'link': 'https://stackoverflow.com/questions/70718940/pokemon-api-request-generate-5-pok%c3%a9mon-at-a-time', 'title': 'Pokemon API request generate 5 Pokémon at a time'}, {'tags': ['java'], 'owner': {'account_id': 919945, 'reputation': 43, 'user_id': 951797, 'user_type': 'registered', 'profile_image': 'https://www.gravatar.com/avatar/26b06d5d95992fa3780383abe5f49a3d?s=256&d=identicon&r=PG', 'display_name': 'Brian', 'link': 'https://stackoverflow.com/users/951797/brian'}, 'is_answered': True, 'view_count': 32556, 'accepted_answer_id': 7942409, 'answer_count': 3, 'score': 3, 'last_activity_date': 1577442848, 'creation_date': 1319931614, 'question_id': 7942384, 'content_license': 'CC BY-SA 3.0', 'link': 'https://stackoverflow.com/questions/7942384/simple-java-pokemon-fight-simulator', 'title': 'Simple Java Pokemon Fight Simulator'}]

wikipedia

# Usage:
from TheAPI import api

result = api.wikipedia(query='pokemon')
print(result)

# Result:
{'title': 'Pokémon', 'summary': 'Pokémon is a Japanese media franchise consisting of video games, animated series and films, a trading card game, and other related media. The franchise takes place in a shared universe in which humans co-exist with creatures known as Pokémon, a large variety of species endowed with special powers. The franchise\'s target audience is children aged 5 to 12, but it is known to attract people of all ages.\nThe franchise originated as a pair of role-playing games developed by Game Freak, from an original concept by its founder, Satoshi Tajiri. Released on the Game Boy on February 27, 1996, the games became sleeper hits and were followed by manga series, a trading card game, and anime series and films. From 1998 to 2000, Pokémon was exported to the rest of the world, creating an unprecedented global phenomenon dubbed "Pokémania". By 2002, the craze had ended, after which Pokémon became a fixture in popular culture, with new products being released to this day. In the summer of 2016, the franchise spawned a second craze with the release of Pokémon Go, an augmented reality game developed by Niantic. Pokémon has since been estimated to be the world\'s highest-grossing media franchise and one of the best-selling video game franchises.\nPokémon has an uncommon ownership structure. Unlike most IPs, which are owned by one company, Pokémon is jointly owned by three: Nintendo, Game Freak, and Creatures. Game Freak develops the core series role-playing games, which are published by Nintendo exclusively for their consoles, while Creatures manages the trading card game and related merchandise, occasionally developing spin-off titles. The three companies established The Pokémon Company (TPC) in 1998 to manage the Pokémon property within Asia. The Pokémon anime series and films are co-owned by Shogakukan. Since 2009, The Pokémon Company International (TPCi), a subsidiary of TPC, has managed the franchise in all regions outside of Asia.\n\n', 'url': 'https://en.wikipedia.org/?curid=23745', 'image_url': 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/98/International_Pok%C3%A9mon_logo.svg/500px-International_Pok%C3%A9mon_logo.svg.png'}

words

# Usage:
from TheAPI import api

result = api.words(num_words=5)
print(result)

# Result:
['inaptitude', 'equitablenesses', 'streamy', 'teazle', 'outpreening']

write

# Usage:
from TheAPI import api

result = api.write(text='pokemon')
print(result)

# Result:
https://envs.sh/0Q7.jpg

This Project is Licensed under MIT License