REST API

The Rest API for Ryandw11 Images.

The API returns ImageObjects and UserObjects.

Ping

GET https://img.ryandw11.com/api/v1/ping

Check if the Ryandw11 Images service is online.

pong

Get Images

GET https://img.ryandw11.com/api/v1/images

Get a list of images from Ryandw11 Images. Note: Not all images are obtained at once. A page system is used to restrict the amount of data at once. The default amount of images per page is 30, but you can obtain up to 100 at a time.

Query Parameters

NameTypeDescription

imgCount

number

The number of images to obtain. (Default 30)

pge

number

The current page for images. (Default 1)

title

string

Only get images that match the provided titles.

{
    "error": false,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalImageCount": number,
    "images": [ImageObject]
}

User Images

GET https://img.ryandw11.com/api/v1/images/:user

Get the images for a certain user. (Note: Unlisted images cannot be obtained).

Path Parameters

NameTypeDescription

user

string

The UUID of the user to obtain images for.

Query Parameters

NameTypeDescription

imgCount

string

The number of images to obtain. (Default 30)

title

string

Only get images that match the provided titles.

pge

number

The page number of the page of images.

{
    "error": false,
    "uuid": String,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalImageCount": number,
    "images": [ImageObject]
}

Get Users

GET https://img.ryandw11.com/api/v1/users

Get a list of users. Like the images, this is a paged list. Note: Admin users will not be returned.

Query Parameters

NameTypeDescription

userCount

number

The number of users to display per page. (Default 30)

username

string

Display users that match the username requirement.

pge

number

The page number for the users.

{
    "error": false,
    "hasPreviousPage": boolean,
    "hasNextPage": boolean,
    "pageNumber": number,
    "totalUserCount": number,
    "users": [UserObject]
}

Last updated