Peekio API Documentation

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.

What is an API, anyway?

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?

Example JSON

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.

Requirements

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!

Query Strings

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.