Package: pointercratepy
Pointercrate Python APIpointercratepy is a library that provides its users ability to interact with the api ofPointercrate.Explore the docsReport Bug|Request FeatureTable of ContentsAbout The ProjectBuilt WithGetting StartedInstallationUsageDocumentationDemonsPlayersExampleslimitnamename_containsafter | beforeverifier_idpublisher_idpublisher_namelistednationRoadmapContributingLicenseContactCreditsChangelogAbout the projectBuilt WithPython 3.9Getting StartedInstallationWindowspython -m pip install pointercratepyLinuxpython3-mpipinstallpointercratepyUsagefrompointercratepyimportClientclient=Client()Documentationpointercratepy allows you searching and interacting with the demons of pointercrate !
You can also get information about the demons that are not in the list anymore.Demonsfunctionget_demons(**options)Parameters:limit(Optional[int]) - The maximum amount of object to return. Must lie between 1 and 100 | Default is50name(Optional[str]) - Filter with the name of the demon [!!!] Case sensitive [!!!]name_contains(Optional[str]) - Check if a demon has the specified string in his name, not case sensitive 
        so it's a good alternative to name filter.after(Optional[int]) - Used for pagination, example below.before(Optional[int]) - Used for pagination, example below.verifier_id(Optional[int]) - Filter with the verifier's id.publisher_id(Optional[int]) - Filter with the publisher's id.publisher_name(Optional[str]) - Filter with the name of the player who uploaded the level.  [!!!] Case sensitive [!!!]listed(Optional[bool]) - Sort the levels by their position in the list. | Default isTrueReturns:All demons information.Return type:List of objects[{"id":250,"position":1,"name":"Tartarus","requirement":47,"video":"https://www.youtube.com/watch?v=9YYQBbrsV5Y","publisher":{"id":34134,"name":"Dolphy","banned":false},"verifier":{"id":34134,"name":"Dolphy","banned":false},"level_id":59075347},{"id":274,"position":2,"name":"The Golden","requirement":50,"video":"https://www.youtube.com/watch?v=Aas8_QKLnuc","publisher":{"id":35150,"name":"BoBoBoBoBoBoBo","banned":false},"verifier":{"id":5240,"name":"nSwish","banned":false},"level_id":60978746}]idType:intThe ID of the object in the
database.positionType:intThe position of the demon in the
list.nameType:strThe name of the demon.requirementType:intThe requirement % to get your record
accepted.videoType:strLink of the video of the level.Objectpublisher: contains information about the player who uploaded the levelidType:intPlayer's ID.nameType:strPlayer's name.bannedType:boolIf the player is banned from pointercrate or not.Objectverifier: contains information about the player who verified the levelidType:intPlayer's ID.nameType:strPlayer's name.bannedType:boolIf the verifier is banned from pointercrate or not.level_idType:intThe ID of the demon.Playersfunctionget_players_ranked(**options)Parameters:limit(Optional[int]) - The maximum amount of object to return. Must lie between 1 and 100 | Default is50name(Optional[str]) - Filter with the name of the player [!!!] Case sensitive [!!!]name_contains(Optional[str]) - Check if a player has the specified string in his name, not case sensitive 
        so it's a good alternative to name filter.nation(Optional[str]) - Filter with the nation of the player.after(Optional[int]) - Used for pagination, example below.before(Optional[int]) - Used for pagination, example below.Returns:All player's information.Return type:List of objects[{"id":34124,"name":"Wolvez","rank":1,"score":4466.7859672865025,"nationality":{"country_code":"SE","nation":"Sweden","subdivision":null}}]idType:intThe ID of the player.rankType:intThe position of the player in the
list.scoreType:floatThe number of list points that the
player has.Objectnationality: contains information about the location of the playercountry_codeType:strISO country code.nationType:strNation's name.subdivisionType:strSubdivision of the nation.ExampleslimitfrompointercratepyimportClientclient=Client()demons=client.get_demons(limit=3)# [{....}, {....}, {....}]# List of 3 objects containing the top 3# demonlist from march 2021print(demons[0].get("name"))# Tartarusprint(demons[1].get("name"))# The Goldenprint(demons[2].get("name"))# Zodiacname - CASE SENSITIVEfrompointercratepyimportClientclient=Client()demons=client.get_demons(name="Tartarus")# [{....}]# List with one object containing information about the demon named Tartarusdemons=client.get_demons(name="tartarus")# [] Empty listname_contains - NOT CASE SENSITIVEfrompointercratepyimportClientclient=Client()demons=client.get_demons(name_contains="blade")# [{Edge of the Blade's info}, {Blade of Justice's info}....]# List of levels containing "edge" in their namedemons=client.get_demons(name_contains="tartarus")# [{ "Tartarus's info "}]# As you can see, it's not case sensitive so it can be a good alternative to "name"after | beforefrompointercratepyimportClientclient=Client()demons=client.get_demons(after=5,before=9)# [{...}, {...}]# Demons which are at position 6, 7 and 8demons=client.get_demons(limit=100)# [{...}, {...}, ...] List of top 100 demonsdemons=client.get_demons(limit=100,after=100)# [{...}, {...}, ...] Demons between top 101 and 200verifier_id# Kugelblitz's id is 598frompointercratepyimportClientclient=Client()demons=client.get_demons(verifier_id=598)# [{SARY NEVER CLEAR's info}]# List of levels that Kugelblitz has verifiedpublisher_id# Dolphy's id is 34134frompointercratepyimportClientclient=Client()demons=client.get_demons(publisher_id=34134)# [{Tartarus's info}]# List of levels that Dolphy has uploadedpublisher_name - CASE SENSITIVEfrompointercratepyimportClientclient=Client()demons=client.get_demons(publisher_name="ViPriN")# [{...}, {...}, ...] Contains all levels uploaded by "ViPriN"demons=client.get_demons(publisher_name="viprin")# [{}] No results because it's case sensitivelistedfrompointercratepyimportClientclient=Client()demons=client.get_demons(listed=True)# default value, give the demons ordered by positiondemons=client.get_demons(listed=False)# give the demons disorderlynationfrompointercratepyimportClientclient=Client()players=client.get_players_ranked(limit=2,nation="FR")# [{....}, {....}]players=client.get_players_ranked(limit=2,nation="France")# [{....}, {....}]# This will give the same results since you can filter both by country code and country name# List of 2 objects containing the top 2 french players# demonlist from june 2022print(players[0].get("name"))# GDonutprint(players[1].get("name"))# BoodbdogRoadmapSee theopen issuesfor a list of proposed features (and known
issues).ContributingContributions are what make the open source community such an amazing place to be learned, inspire, and create. Any
contributions you make aregreatly appreciated.Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull RequestLicenseDistributed under the MIT License. SeeLICENSEfor more information.ContactHikudo -@bretheskevin-bretheskevin@gmail.comDiscord - Hikudo#1714CreditsThanks tonekitdev, this is my first API wrapper and his work ongd.pyhelped me to write de documentation and find a description for the project.Thanks to Nimbus who answered my questions about the REST API of pointercrate.Changelog [day/month/year]0.0.1 < 1.0.0 (13/03/2021)Setting up pipFirst releaseMethod get_demons() : Get information about the demons of pointercrate.1.0.1 & 1.0.2 (13/03/2021)Documentation correction1.1.0 (06/30/2022)Method get_players_ranked() : Get information about the ranked players of pointercrate.Simplified the code and changed some grammarProject Link:https://github.com/bretheskevin/pointercrate.py