igdb-api Documentation

Transcription

1 igdb-api Documentation Release easy change Oct 26, 2017

2

3 Contents 1 igdb-api Features Installation From sources Concepts Fields Filters Text search Ordering Usage and Examples Games Companies Franchises Genres Keywords People Platforms Player Perspectives Pulses Series Themes Examples with filters Contributing Types of Contributions Get Started! Pull Request Guidelines History ( ) i

4 ii

5 Contents: Contents 1

6 2 Contents

7 CHAPTER 1 igdb-api Unofficial python api for igdb Features Requests json objects from igdb: Games Companies Franchises Genres Keywords People Platforms Player Perspectives Pulses Series Themes For more information please visit 3

8 4 Chapter 1. igdb-api

9 CHAPTER 2 Installation From sources The sources for igdb-api can be downloaded from the Github repo. You can either clone the public repository: $ git clone git://github.com/nuxlic/igdb-api Or download the tarball: $ curl -OL Once you have a copy of the source, you can install it with: $ python setup.py install 5

10 6 Chapter 2. Installation

11 CHAPTER 3 Concepts Extract of Fields Fields are properties of an entity. For example, a Game field would be rating or release_dates. Some fields have properties of their own, for example, the esrb field has the property synopsis. Fields are requested in a comma separated list. For example, to get some information for some Games, Genres, Themes or anything else, you could request it like this: fields = 'name,release_dates,esrb.synopsis,rating' Note the synopsis property of esrb can be accessed directly with a dot. The timestamps/dates is always measured in nanoseconds since unix epoch. A full list of fields can be obtained by passing a * as a field. Filters Filters are used to sift through results to get what you want. You can exclude and include results based on their properties. For example you could remove all Games where the rating was below 80 (filter[rating][gte]=80). >> from igdb import Filter >> from igdb.operators import GTE, GT >> filter = Filter(field='rating', operator=gte, value=80) >> filter = Filter(field='release_dates.date', operator=operators.gt, value=' ') The filter itself comprises of 2 parts; The field and the postfix. Fields are described in the section on the left, postfixes are described below. 7

12 Available Postfixes: eq: Exact match equal. gt: Greater than works only on numbers. gte: Greater than or equal to works only on numbers. lt: Less than works only on numbers. lte: Less than or equal to works only on numbers. prefix: Prefix of a value only works on strings. exists: The value is not null. Text search search: This parameter is not like other filters. It is an independant parameter that performs a full text search. Ordering Ordering (Sorting) is used to order results by a specific field. You can order results like this: order = 'release_dates.date:desc' Notice the appended :desc which could also be :asc if required. 8 Chapter 3. Concepts

13 CHAPTER 4 Usage and Examples First you need an api key. Please visit to get it. To use igdb-api: >> from igdb.requester import Requester >> api_key = 'sk2awpgu1smshudwmsdsdsfsgfsdfsh4gb9hp1pwauejsnsl1wo4sisyri' >> req = Requester(api_key) Games >> req.get_games(fields='*', limit=10, offset=0, order='release_dates.date:desc', search='crysis')[1] >> {'aggregated_rating': , 'category': 0, 'collection': 36, 'cover': {'cloudinary_id': 'ql2wkpjr0wr8s42qnd9o', 'height': 1964, 'width': 1530}, 'created_at': , 'developers': [122, 158], 'esrb': {'rating': 6, 'synopsis': 'This is a first-person shooter in which players assume ' 'the role of a soldier who battles an evil corporation ' 'and must defend Earth from alien invasion. Players use ' 'handguns, machine guns, rocket launchers, and ' 'futuristic weapons to kill Ceph aliens and human ' 'soldiers. Players can also engage in close-up ' "hand-to-hand combat: slicing enemies' throats, breaking " 'their necks. The frenetic combat includes realistic ' 'gunfire, screams of pain, and frequent explosions. ' 'Characters emit large splashes of blood when shot or ' 'stabbed; bloodstains can be seen on the ground. The ' 9

14 'words f**k and sh*t can be heard in the dialogue.'}, 'game_engines': [25], 'genres': [5, 31], 'id': 1268, 'keywords': [132, 453, 466, 1025, 1917, 2210], 'name': 'Crysis 3', 'pegi': {'rating': 4, 'synopsis': 'The content of this game is suitable for persons aged ' '16 years and over only.\n' 'It contains: Realistic looking violence - - Strong ' 'language\n' 'This game allows the player to interact with other ' 'players ONLINE'}, 'publishers': [1], 'rating': , 'rating_count': 42, 'release_dates': [{'category': 0, 'date': , 'platform': 6}, {'category': 0, 'date': , 'platform': 12}, {'category': 0, 'date': , 'platform': 9}], 'screenshots': [{'cloudinary_id': 'w4wtnrsi7adlgqdrcquh', 'height': 360, 'width': 640}, {'cloudinary_id': 'vdc5hsctsutblkjbdhux', 'height': 1080, 'width': 1920}, {'cloudinary_id': 'hb9udiacxii5dezi2jsa', 'height': 360, 'width': 640}, {'cloudinary_id': 'ldrntvvj3rn6snpke6bd', 'height': 360, 'width': 640}, {'cloudinary_id': 'ria78seajdtfopxhlkjr', 'height': 360, 'width': 640}], 'slug': 'crysis-3', 'storyline': 'Return to the fight as Prophet, the Nanosuit soldier on a quest ' 'to rediscover his humanity. Adapt on the fly with the stealth ' 'and armor abilities of your unique Nanosuit as you battle ' 'through the seven wonders of New York s Liberty Dome. Unleash ' 'the firepower of your all-new, Predator bow and alien weaponry ' 'to hunt both human and alien enemies.', 'summary': 'The award-winning developer Crytek is back with Crysis 3, the ' 'first blockbuster shooter of 2013! Crysis 3 is the ultimate ' 'sandbox shooter, realized in the stunning visuals only Crytek and ' 'the latest version of CryENGINE can deliver. Available now on ' 'Xbox 360, PlayStation 3, and PC.', 'themes': [23, 18], 'updated_at': , 'url': ' 'videos': [{'name': 'The Hunt Is On Trailer', 'video_id': 'laoakmuavsq'}]} Companies >> req.get_companies(fields='*', limit=10, offset=0)[1] >> {'change_date_category': 7, 10 Chapter 4. Usage and Examples

15 'created_at': , 'developed': [13046], 'id': 10172, 'name': 'Source the Software House', 'slug': 'source-the-software-house', 'start_date_category': 7, 'updated_at': , 'url': ' Franchises >> req.get_franchises(fields='*')[1] >> {'created_at': , 'games': [22388, 22389, 22390], 'id': 844, 'name': 'Death Note', 'slug': 'death-note', 'updated_at': , 'url': ' Genres >> req.get_genres(fields='*', limit=40)[1] >> {'created_at': , 'games': [1031, 22381, 22383, 22386, 22387, 18148, 18981, 22403, 22409, 22414, 22417], 'id': 32, 'name': 'Indie', 'slug': 'indie', 'updated_at': , 'url': ' Keywords >> req.get_keywords(fields='*', limit=50, offset=0)[1] >> {'created_at': , 'games': [4838, 7060, 8862], 'id': 1081, 'name': 'masked wrestling', 'slug': 'masked-wrestling', 4.3. Franchises 11

16 'updated_at': , 'url': ' People >> req.get_people(fields='*') >> {'created_at': , 'games': [8223, 3025], 'gender': 0, 'id': 32377, 'name': 'Kristianne Bilodeau', 'slug': 'kristianne-bilodeau', 'updated_at': , 'url': ' Platforms >> req.get_platforms(fields='*', limit=50, offset=0)[1] >> {'alternative_name': 'Nintendo Super Disc', 'created_at': , 'id': 131, 'name': 'Nintendo PlayStation', 'slug': 'nintendo-playstation', 'updated_at': , 'url': ' 'versions': [{'name': 'Initial version', 'slug': 'initial-version', 'url': ' initial-version'}]} Player Perspectives >> req.get_player_perspectives(fields='*')[1] >> {'created_at': , 'games': [9076, 2629, 7698, 8597, 8662, 8612, 18981], 'id': 6, 'name': 'Aural', 'slug': 'aural', 'updated_at': , 'url': ' 12 Chapter 4. Usage and Examples

17 Pulses >> req.get_pulses(fields='*')[1] >> {'author': 'MaGuishi', 'category': 1, 'id': 6711, 'image': ' 8p0sfnjMW2eZrhsleA5Lk.jpg', 'published_at': , 'title': 'Los 'uid': '4711ju', 'url': '/r/gaming/comments/4711ju/los_santosminecraft/'} Series >> req.get_series(fields='*')[1] >> {'created_at': , 'games': [8817], 'id': 1192, 'name': 'Smugglers', 'slug': 'smugglers', 'updated_at': , 'url': ' Themes >> req.get_themes(fields='*', limit=40)[1] >> {'created_at': , 'games': [1712, 8567, 22408, 19930, 22417], 'id': 40, 'name': 'Party', 'slug': 'party', 'updated_at': , 'url': ' Examples with filters >> from igdb import Filter >> from igdb.operators import EQ >> filter_name = Filter(field='name', operator=eq, value='crysis 3') >> req.get_games(fields='*', limit=10, offset=0, order='release_dates.date:desc', filters=[filter_name]) 4.9. Pulses 13

18 14 Chapter 4. Usage and Examples

19 CHAPTER 5 Contributing Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways: Types of Contributions Report Bugs Report bugs at If you are reporting a bug, please include: Your operating system name and version. Any details about your local setup that might be helpful in troubleshooting. Detailed steps to reproduce the bug. Fix Bugs Look through the GitHub issues for bugs. Anything tagged with bug and help wanted is open to whoever wants to implement it. Implement Features Look through the GitHub issues for features. Anything tagged with enhancement and help wanted is open to whoever wants to implement it. 15

20 Write Documentation igdb-api could always use more documentation, whether as part of the official igdb-api docs, in docstrings, or even on the web in blog posts, articles, and such. Submit Feedback The best way to send feedback is to file an issue at If you are proposing a feature: Explain in detail how it would work. Keep the scope as narrow as possible, to make it easier to implement. Remember that this is a volunteer-driven project, and that contributions are welcome :) Get Started! Ready to contribute? Here s how to set up igdb-api for local development. 1. Fork the igdb-api repo on GitHub. 2. Clone your fork locally: $ git clone git@github.com:your_name_here/igdb-api.git 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development: $ mkvirtualenv igdb-api $ cd igdb-api/ $ python setup.py develop 4. Create a branch for local development: $ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. 5. When you re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox: $ flake8 igdb_api tests $ python setup.py test or py.test $ tox To get flake8 and tox, just pip install them into your virtualenv. 6. Commit your changes and push your branch to GitHub: $ git add. $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature 7. Submit a pull request through the GitHub website. 16 Chapter 5. Contributing

21 Pull Request Guidelines Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests. 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst. 3. The pull request should work for Python 3.3, 3.4 and 3.5, and for PyPy Pull Request Guidelines 17

22 18 Chapter 5. Contributing

23 CHAPTER 6 History ( ) First release. 19