Rest API

The API returns ImageObjects and UserObjects.

note

This page is still under construction. Formatting will be improved in the future.

Ping (GET)

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

Check if the Ryandw11 Images service is online.

Response (200)

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.

Parameters

Query

Name	Type	Description
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.

Responses

Response (200)

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

Response (400)

{
    "error": true, 
    "error_message": String, 
    "images": []
}

Get User Images (GET)

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

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

Parameters

Path

Name	Type	Description
user	string	The UUID of the user to obtain images for.

Query

Name	Type	Description
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.

Responses

Response (200)

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

Response (400)

{
    "error": true, 
    "error_message": String, 
    "images": []
}

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.

Parameters

Query

Name	Type	Description
userCount	number	The number of users to display per page. (Default 30)
username	string	Display users that match the username requirement.
pge	number	The current page for images. (Default 1)

Responses

Response (200)

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

Response (400)

{
    "error": true, 
    "error_message": String, 
    "users": []
}