Before we dive in, thank you so much for showing interest in our API. You are awesome!
This documentation exists to help you utilize our API. Please go through the documentation carefully to understand how it's structured. You will require basic knowledge in fetching json information.
API is short for ‘Application Programming Interface’ . An API is a set of rules that lets programs talk to each other, exposing data and functionality across the Internet in a consistent format.
These URLs represent various resources — any information or content accessed at that location, which can be returned as JSON, XML, VDF, HTML, audio files, images and more. Often resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT, and DELETE.
GET is used to fetch/get the information.
POST is used to create information.
PUT is used to update the information.
DELETE is used to... do I even need to tell you?
This is an example of how our JSON API is formatted. If you GET the string "newsTitle_1" you'll fetch "Welcome to Stallion Squad" in return which you can display anywhere - and it updates whenever we update our API! Cool right?
Mmm... gotta love JSON.
All you really need is a software, website or server where you can display the fetched information. In Stallion Squad we're displaying it in-game using the VaRest plugin for Unreal Engine. If you're in a terminal you could use Curl to make REST API requests directly. Example below!
Please note that some API requests might require you to add values to a query string. A query string is an additional request that is added after a URL. In the User Inventory API you're required to add your 64-bit Steam ID at the end of a query string called ?steamid=. Query strings are a way for the API to understand what you're requesting.
The Stallion Squad API gains you access to the same tools we use at Peekio to obtain Stallion Squad values like item definitions (full list of all items in the game) and the item shop (to know what's currently being sold).
Some API endpoints might have a "key" query string. You can obtain these from Steam here.
Raw values for all Stallion Squad steam items. Includes names, descriptions, tags, type, rarities, colors, images, recipes, tradeable/marketable.
Raw values for all users currently on the desired leaderboard. Includes Steam ID, score and rank.
Raw values displaying info about Stallion Squad items the specified user has in their steam inventory.
Raw values displaying information about Steam achievements earnt by the specified user.
Peekio Connect is built up by a ton of seperate widgets which you can embed on your own website or application. We use embed widgets in our Peekio android app using the WebView feature in Android Studio. You could use HTML iframe tags to embed these widgets on a website as well.
Each widget is made up of components. Here is an example of the homepage with all components enabled:
You can see that this link has the components "menu", "sidebar", "input" and "feed" enabled. You can add or remove these from the link (after ?components=). Combining components together can make for some interesting results and is a way for you to integrate Peekio Connect neatly into your design. Choose the components that work for you and voilà.
The game feed widget displays different components of a game including breadcrumb, header, suggestions, feed, input, and sidebar.
The group widget displays different components of a group including header, banner, breadcrumb, input, feed, and members.
This widget displays a particular post including post, topics, share and responses.
The user widget displays different components of a user profile including header, menu, and main.
Displays a list of logged in user’s notifications. Requires user to be logged in. connect.peekio.no/embed/notifications
This widget displays different components of a particular question including question, answers, stats, relatedQuestions, share, and topics.
This widget displays components of a particular answer including answer, and more.
The home widget displays the entire Peekio Connect feed. It includes the feed, input, menu, and sidebar.
The Peekio Connect RSS Feed is a web feed that allows users and applications to access updates in a standardized, computer-readable format. These feeds can, for example, allow a user to keep track of many different websites in a single news aggregator.