API Documentation

Introduction

The Fuck Orbital API allows other applications to programmatically access the data contained in the Fuck Orbital web application.

The API is currently version 1.0. All endpoints URLs start with https://meebleforp.com/projects/fuck-orbital/api/v1

Endpoints


Response Format

The API will always response in JSON. JSONP is available by using the callback query parameter

Response types

Responses come in lists and singular objects.

Lists

Lists represent collection of objects. Lists are paginated. The page you're retrieving is specified by the page query parameter, and the size of the page by pagesize. The default page size is 30 while the maximum is 100. Each paginated request also comes other metadata that allows you to retrieve the next or previous page of content.

The actual items will always appear under the data key. Here is an example call to the fucks endpoint that shows all metadata returned by list endpoints:

{
    "total": 20,
    "per_page": "10",
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "https://meebleforp.com/projects/fuck-orbital/v1/fucks?page=2",
    "prev_page_url": null,
    "from": 1,
    "to": 10,
    "data": [...]
}

Objects

Object endpoints require one or more semicolon separated IDs. The API will attempt to retrieve those items. Items that are not available will not appear in the results. The objects are not returned in any specific ordering. The maximum number of objects returned in a single query is 30. If more than 30 IDs are requested, then only the first 30 are returned.

{
    "total": 3,
    "data": [...]
}