bradleyhodges / gamersapi Goto Github PK

This section contains the API's, example uses and example responses. All response content-type's are JSON. Here are the API's we currently offer:

KiK Messenger API

Rockstar Games Socialclub API

Rockstar Games Socialclub Button

PSN Avatar API

KiK Messenger does not offer a user information API. We rely solely on people doing the right thing, and not abusing the API. KiK is a popular choice of messaging app for gaming communities; it's a fast, secure, convenient messenger, and it's all-round pretty awesome.

Our API allows you to get a user's display name, KiK avatar and a secure (https) version of the user's KiK avatar.

The API can be accessed via:

https://gamersapi.herokuapp.com/apis/kik/{kik username}

Example Use:

https://gamersapi.herokuapp.com/apis/kik/cheapapples12

Example Response:

{"username":"cheapapples12", "display_name":"CheapApples12 [NSA Director]", "avatar":"http://profilepics.cf.kik.com/Fh8jwxDfbzVwNOSFTN67fDmPGn4/orig.jpg", "avatar_ssl":"https://gamersapi.herokuapp.com/apis/kik_https/cheapapples12?cache=1"}

Rockstar Games does not offer any way whatsoever to retrieve any information about any crew on the socialclub. We developed the Rockstar Games Socialclub Crew API so that crews can retrieve crew names and hopefully one day, crew avatar images from a Socialclub Crew URL.

We ask that you also use this API modestly, as we rely on a good community relationship with Rockstar Games in order to make this API work.

At the moment, our API allows you to retrieve a crew name from a Socialclub URL.

The API can be accessed via:

https://gamersapi.herokuapp.com/apis/rsg/{full socialclub url}

Example Use:

https://gamersapi.herokuapp.com/apis/rsg/https://socialclub.rockstargames.com/crew/los_santos_police_xb

Example Response:

{"crew_name":"Los Santos Police XB"}

Twitter-style Add Friend buttons for the Rockstar Games Socialclub!

The API can be accessed by embedding the following into a webpage:

<a href="https://socialclub.rockstargames.com/member/{socialclub username}" class="rsg_btn" data-compare-lsgov="true">Add @{socialclub username}</a><script async src="//gamersapi.herokuapp.com/rsg/script.js" charset="utf-8"></script>

Example Use:

<a href="https://socialclub.rockstargames.com/member/priceybanana16" class="rsg_btn" data-compare-lsgov="true">Add @PriceyBanana16</a><script async src="//gamersapi.herokuapp.com/rsg/script.js" charset="utf-8"></script>

Example Response:

Add @CheapApples12<script async src="//gamersapi.herokuapp.com/rsg/script.js" charset="utf-8"></script>

Sony do not allow users to retrieve Playstation Avatars via any public API endpoint, so we made one for them. The PSN Avatar API is a JSON API.

The API can be accessed via:

https://gamersapi.herokuapp.com/apis/psn/{psn id}

Example Use:

https://gamersapi.herokuapp.com/apis/psn/yowmudder

Example Response:

{"avatar":"https://static-resource.np.community.playstation.net/avatar_m/WWS_A/A0002_m.png"}

GamersAPI is Open Source, which means you're free to use the API's, as long as you do not remove the attribution statements from the top of the API's, and as long as you don't attempt to market the API as your own, or attempt to charge money for people to use the API's.

GamersAPI does not need composer, or any third-party software. The only requirements are as follows:

• PHP => 5.0
• allow_url_fopen allowed

If you do not want to download the api's, you are welcome to use our Heroku hosted API's. If you choose to download the APIs, you must not remove or change the copyright statement at the top of the .php files.

If you have a project that requires information from a website or application that does not have an API, feel free to make a request, and I'll be sure to have a crack at it. Any API's I develop that can be considered game-related will be added here. If you want to suggest an API, open a new issue.