Image Chest API

https://imgchest.com/docs/api/1.0/
Admin
The Image Chest API allows you to interact with the site via a standardized programming interface,...
Tokens:6,957
Snippets:35
Trust Score:9.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Bulk File Update Response

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Example response containing the updated details for multiple files.

```json
{
    "data": [
        {
            "id": "nw7w6cmlvye",
            "description": "Released in the arcades in 1981, Donkey Kong...",
            "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
            "position": 1,
            "created": "2019-11-03T00:36:00.000000Z"
        },
        {
            "id": "kwye3cpag4b",
            "description": "Mario's character design, particularly his large nose, draws on western influences;",
            "link": "https://cdn.imgchest.com/files/kwye3cpag4b.png",
            "position": 2,
            "created": "2019-11-03T00:36:00.000000Z"
        }
    ]
}
```

--------------------------------

### Retrieve File Information Response

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Example JSON response containing metadata for a specific file.

```json
{
    "data": {
        "id": "nw7w6cmlvye",
        "description": "Released in the arcades in 1981, Donkey Kong...",
        "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
        "position": 1,
        "created": "2019-11-03T00:36:00.000000Z"
    }
}
```

--------------------------------

### Retrieve Post Information

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Example JSON response for a GET request to the post information endpoint. If the post belongs to the authenticated user, additional fields like delete_url and original_name are included.

```json
{
    "data": {
        "id": "3qe4gdvj4j2",
        "title": "Donkey Kong - Video Game From The Mid 80's",
        "username": "LunarLandr",
        "privacy": "public",
        "report_status": 1,
        "views": 198,
        "nsfw": 0,
        "image_count": 4,
        "created": "2019-11-03T00:36:00.000000Z",
        "images": [
            {
                "id": "nw7w6cmlvye",
                "description": "Released in the arcades in 1981, Donkey Kong...",
                "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
                "position": 1,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "kwye3cpag4b",
                "description": null,
                "link": "https://cdn.imgchest.com/files/kwye3cpag4b.png",
                "position": 2,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "5g4z9c8ok72",
                "description": null,
                "link": "https://cdn.imgchest.com/files/5g4z9c8ok72.png",
                "position": 3,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "we4gdcv5j4r",
                "description": null,
                "link": "https://cdn.imgchest.com/files/we4gdcv5j4r.jpg",
                "position": 4,
                "created": "2019-11-03T00:36:00.000000Z"
            }
        ]
    }
}
```

--------------------------------

### GET https://api.imgchest.com/v1/file/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Retrieves information about a specific file by its ID.

```APIDOC
## GET https://api.imgchest.com/v1/file/{id}

### Description
Provides information about a specific file.

### Method
GET

### Endpoint
https://api.imgchest.com/v1/file/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the file.

### Response
#### Success Response (200)
- **data** (object) - File details including id, description, link, position, and created timestamp.

#### Response Example
{
    "data": {
        "id": "nw7w6cmlvye",
        "description": "Released in the arcades in 1981, Donkey Kong...",
        "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
        "position": 1,
        "created": "2019-11-03T00:36:00.000000Z"
    }
}
```

--------------------------------

### Bulk File Update Request

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Example request body for updating multiple files simultaneously.

```json
{
    "data": [
        {
            "id": "nw7w6cmlvye",
            "description": "Released in the arcades in 1981, Donkey Kong..."
        },
        {
            "id": "kwye3cpag4b",
            "description": "Mario's character design, particularly his large nose, draws on western influences;"
        }
    ]
}
```

--------------------------------

### Example Response - Other User's Posts

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Represents the JSON structure returned when viewing another user's public posts.

```json
{
    "data": [
        {
            "id": "3qe4gdvj4j2",
            "title": "Donkey Kong - Video Game From The Mid 80's",
            "slug": "3qe4gdvj4j2",
            "link": "https://imgchest.com/p/3qe4gdvj4j2",
            "nsfw": 0,
            "score": 125,
            "comments": 8,
            "views": 1523,
            "thumbnail": {
                "id": "nw7w6cmlvye",
                "description": "Released in the arcades in 1981...",
                "link": "https://cdn.imgchest.com/files/thumb/nw7w6cmlvye.png",
                "mp4": 0,
                "position": 1,
                "mime_type": "image/png",
                "nsfw": false
            }
        }
    ],
    "links": {
        "first": "https://api.imgchest.com/v1/user/LunarLandr/posts?page=1",
        "last": "https://api.imgchest.com/v1/user/LunarLandr/posts?page=10",
        "prev": null,
        "next": "https://api.imgchest.com/v1/user/LunarLandr/posts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 10,
        "path": "https://api.imgchest.com/v1/user/LunarLandr/posts",
        "per_page": 15,
        "to": 15,
        "total": 147
    }
}
```

--------------------------------

### Example Response - Own Posts

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Represents the JSON structure returned when a user requests their own posts, including private and hidden content.

```json
{
    "data": [
        {
            "id": "3qe4gdvj4j2",
            "title": "My Private Gallery",
            "slug": "3qe4gdvj4j2",
            "link": "https://imgchest.com/p/3qe4gdvj4j2",
            "nsfw": 0,
            "score": 15,
            "comments": 3,
            "views": 42,
            "thumbnail": {
                "id": "nw7w6cmlvye",
                "description": "First image",
                "link": "https://cdn.imgchest.com/files/thumb/nw7w6cmlvye.png",
                "mp4": 0,
                "position": 1,
                "mime_type": "image/png",
                "nsfw": false
            }
        }
    ],
    "links": {
        "first": "https://api.imgchest.com/v1/user/YourUsername/posts?page=1",
        "last": "https://api.imgchest.com/v1/user/YourUsername/posts?page=5",
        "prev": null,
        "next": "https://api.imgchest.com/v1/user/YourUsername/posts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "https://api.imgchest.com/v1/user/YourUsername/posts",
        "per_page": 15,
        "to": 15,
        "total": 73
    }
}
```

--------------------------------

### GET https://api.imgchest.com/v1/users/me

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Retrieves comprehensive information about the currently authenticated user.

```APIDOC
## GET https://api.imgchest.com/v1/users/me

### Description
Retrieves comprehensive information about the authenticated user.

### Method
GET

### Endpoint
https://api.imgchest.com/v1/users/me

### Response
#### Success Response (200)
- **data** (object) - Contains user profile details including ID, name, email, settings, and statistics.

#### Response Example
{
    "data": {
        "id": 123,
        "name": "YourUsername",
        "email": "user@example.com",
        "email_verified": true,
        "biography": "A brief description about myself",
        "avatar_url": "https://cdn.imgchest.com/files/avatar/user_avatar.png",
        "role_id": 0,
        "allow_nsfw": false,
        "show_nsfw_media": false,
        "email_notifications": true,
        "email_promotions": false,
        "posts": 247,
        "comments": 152,
        "favorites": 89,
        "post_views": 125000,
        "created_at": "2019-09-25T01:00:45.000000Z",
        "updated_at": "2024-12-15T14:30:00.000000Z",
        "experience": {
            "points": 1250,
            "level": 15
        },
        "achievements": 8,
        "is_subscribed": false
    }
}
```

--------------------------------

### GET https://api.imgchest.com/v1/post/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Retrieves detailed information about a specific post by its ID.

```APIDOC
## GET https://api.imgchest.com/v1/post/{id}

### Description
Provides information about a specific post.

### Method
GET

### Endpoint
https://api.imgchest.com/v1/post/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the post.

### Response
#### Success Response (200)
- **data** (object) - The post information object containing details like title, username, privacy, and images.

#### Response Example
{
    "data": {
        "id": "3qe4gdvj4j2",
        "title": "Donkey Kong - Video Game From The Mid 80's",
        "username": "LunarLandr",
        "privacy": "public",
        "report_status": 1,
        "views": 198,
        "nsfw": 0,
        "image_count": 4,
        "created": "2019-11-03T00:36:00.000000Z",
        "images": [
            {
                "id": "nw7w6cmlvye",
                "description": "Released in the arcades in 1981, Donkey Kong...",
                "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
                "position": 1,
                "created": "2019-11-03T00:36:00.000000Z"
            }
        ]
    }
}
```

--------------------------------

### GET https://api.imgchest.com/v1/user/{username}

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Provides information about a specific user. Viewing your own profile returns private settings, while viewing others returns public information.

```APIDOC
## GET https://api.imgchest.com/v1/user/{username}

### Description
Provides information about a specific user. Viewing your own profile returns private settings, while viewing others returns public information.

### Method
GET

### Endpoint
https://api.imgchest.com/v1/user/{username}

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user to retrieve.

### Response
#### Success Response (200)
- **data** (object) - Contains user profile information. Private fields are included only when viewing your own profile.

#### Response Example
{
    "data": {
        "name": "YourUsername",
        "biography": "A brief description about myself",
        "avatar_url": "https://cdn.imgchest.com/files/avatar/user_avatar.png",
        "posts": 247,
        "comments": 152,
        "favorites": 89,
        "post_views": "125000",
        "created": "2019-09-25T01:00:45.000000Z",
        "experience": {
            "points": 1250,
            "level": 15
        },
        "achievements": 8,
        "email": "user@example.com",
        "email_verified": true,
        "allow_nsfw": false,
        "show_nsfw_media": false,
        "email_notifications": true,
        "email_promotions": false
    }
}
```

--------------------------------

### GET https://api.imgchest.com/v1/user/{username}/posts

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Retrieves a paginated list of posts for a specific user. Viewing your own posts returns all posts, while viewing another user's posts returns only public posts.

```APIDOC
## GET https://api.imgchest.com/v1/user/{username}/posts

### Description
Retrieves a paginated list of posts for a specific user. Viewing your own posts returns all posts regardless of privacy settings, while viewing another user's posts returns only public posts.

### Method
GET

### Endpoint
https://api.imgchest.com/v1/user/{username}/posts

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user whose posts are being retrieved.

#### Query Parameters
- **per_page** (integer) - Optional - Number of posts per page (max 100). Default: 15
- **sort** (string) - Optional - Sort order: 'new', 'old', or 'views'. Default: new

### Response
#### Success Response (200)
- **data** (array) - List of post objects.
- **links** (object) - Pagination links.
- **meta** (object) - Pagination metadata.

#### Response Example
{
    "data": [
        {
            "id": "3qe4gdvj4j2",
            "title": "My Private Gallery",
            "slug": "3qe4gdvj4j2",
            "link": "https://imgchest.com/p/3qe4gdvj4j2",
            "nsfw": 0,
            "score": 15,
            "comments": 3,
            "views": 42,
            "thumbnail": {
                "id": "nw7w6cmlvye",
                "description": "First image",
                "link": "https://cdn.imgchest.com/files/thumb/nw7w6cmlvye.png",
                "mp4": 0,
                "position": 1,
                "mime_type": "image/png",
                "nsfw": false
            }
        }
    ],
    "links": {
        "first": "https://api.imgchest.com/v1/user/YourUsername/posts?page=1",
        "last": "https://api.imgchest.com/v1/user/YourUsername/posts?page=5",
        "prev": null,
        "next": "https://api.imgchest.com/v1/user/YourUsername/posts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "https://api.imgchest.com/v1/user/YourUsername/posts",
        "per_page": 15,
        "to": 15,
        "total": 73
    }
}
```

--------------------------------

### POST https://api.imgchest.com/v1/post/{id}/add

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Adds images to an existing post.

```APIDOC
## POST https://api.imgchest.com/v1/post/{id}/add

### Description
Adds images to an existing post.

### Method
POST

### Endpoint
https://api.imgchest.com/v1/post/{id}/add

### Parameters
#### Path Parameters
- **id** (string) - Required - The post id.

#### Request Body
- **images[]** (file) - Required - This can be one file or many. Limit 20.

### Response
#### Success Response (200)
- **data** (object) - The updated post object containing the new list of images.
```

--------------------------------

### Current User Information Response

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Returns comprehensive data for the authenticated user, including private settings and account statistics.

```json
{
    "data": {
        "id": 123,
        "name": "YourUsername",
        "email": "user@example.com",
        "email_verified": true,
        "biography": "A brief description about myself",
        "avatar_url": "https://cdn.imgchest.com/files/avatar/user_avatar.png",
        "role_id": 0,
        "allow_nsfw": false,
        "show_nsfw_media": false,
        "email_notifications": true,
        "email_promotions": false,
        "posts": 247,
        "comments": 152,
        "favorites": 89,
        "post_views": 125000,
        "created_at": "2019-09-25T01:00:45.000000Z",
        "updated_at": "2024-12-15T14:30:00.000000Z",
        "experience": {
            "points": 1250,
            "level": 15
        },
        "achievements": 8,
        "is_subscribed": false
    }
}
```

--------------------------------

### POST https://api.imgchest.com/v1/post

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Creates a new post on the Imgchest platform.

```APIDOC
## POST https://api.imgchest.com/v1/post

### Description
Allows you to create a new post.

### Method
POST

### Endpoint
https://api.imgchest.com/v1/post

### Parameters
#### Request Body
- **title** (string) - Optional - The title of the post
- **privacy** (string) - Optional - The privacy setting of your post. Values are public, hidden or secret. Default is hidden.
- **anonymous** (boolean) - Optional - If you do not want your post to not be tied to your user, simply set this parameter as true.
- **nsfw** (boolean) - Optional - This parameter can be true or false.
- **images[]** (file) - Required - This can be one file or many. Limit 20

### Response
#### Success Response (200)
- **data** (object) - The created post object containing id, title, username, privacy, report_status, views, nsfw, image_count, created, and images array.

#### Response Example
{
    "data": {
        "id": "3qe4gdvj4j2",
        "title": "Donkey Kong - Video Game From The Mid 80's",
        "username": "LunarLandr",
        "privacy": "public",
        "report_status": 1,
        "views": 198,
        "nsfw": 0,
        "image_count": 4,
        "created": "2019-11-03T00:36:00.000000Z",
        "images": [
            {
                "id": "nw7w6cmlvye",
                "description": "Released in the arcades in 1981, Donkey Kong...",
                "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
                "position": 1,
                "created": "2019-11-03T00:36:00.000000Z"
            }
        ]
    }
}
```

--------------------------------

### Update File Response

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Confirmation response returned after a successful file update.

```json
{
    "success": "true"
}
```

--------------------------------

### PUT/PATCH https://api.imgchest.com/v1/file/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Updates the details of a specific file that you created.

```APIDOC
## PUT/PATCH https://api.imgchest.com/v1/file/{id}

### Description
Allows you to update details for a file. You may only update files that you created.

### Method
PUT or PATCH

### Endpoint
https://api.imgchest.com/v1/file/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the file.

#### Request Body
- **description** (string) - Optional - The description for the file.

### Response
#### Success Response (200)
- **success** (string) - Confirmation status.

#### Response Example
{
    "success": "true"
}
```

--------------------------------

### PATCH https://api.imgchest.com/v1/files

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Updates details for multiple files in a single request.

```APIDOC
## PATCH https://api.imgchest.com/v1/files

### Description
Allows you to update the details for multiple files. You may only update files that you created.

### Method
PATCH

### Endpoint
https://api.imgchest.com/v1/files

### Request Body
- **data** (array) - Required - An array of objects, each containing 'id' and 'description'.

### Request Example
{
    "data": [
        {
            "id": "nw7w6cmlvye",
            "description": "Released in the arcades in 1981, Donkey Kong..."
        },
        {
            "id": "kwye3cpag4b",
            "description": "Mario's character design, particularly his large nose, draws on western influences;"
        }
    ]
}

### Response
#### Success Response (200)
- **data** (array) - List of updated file objects.

#### Response Example
{
    "data": [
        {
            "id": "nw7w6cmlvye",
            "description": "Released in the arcades in 1981, Donkey Kong...",
            "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
            "position": 1,
            "created": "2019-11-03T00:36:00.000000Z"
        },
        {
            "id": "kwye3cpag4b",
            "description": "Mario's character design, particularly his large nose, draws on western influences;",
            "link": "https://cdn.imgchest.com/files/kwye3cpag4b.png",
            "position": 2,
            "created": "2019-11-03T00:36:00.000000Z"
        }
    ]
}
```

--------------------------------

### DELETE https://api.imgchest.com/v1/file/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/file

Deletes a specific file.

```APIDOC
## DELETE https://api.imgchest.com/v1/file/{id}

### Description
Deletes a file.

### Method
DELETE

### Endpoint
https://api.imgchest.com/v1/file/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the file.

### Response
#### Success Response (200)
- **success** (string) - Confirmation status.

#### Response Example
{
    "success": "true"
}
```

--------------------------------

### Specific User Profile Responses

Source: https://imgchest.com/docs/api/1.0/endpoints/user

Displays profile data for a specific user, with private fields included only when viewing one's own profile.

```json
{
    "data": {
        "name": "YourUsername",
        "biography": "A brief description about myself",
        "avatar_url": "https://cdn.imgchest.com/files/avatar/user_avatar.png",
        "posts": 247,
        "comments": 152,
        "favorites": 89,
        "post_views": "125000",
        "created": "2019-09-25T01:00:45.000000Z",
        "experience": {
            "points": 1250,
            "level": 15
        },
        "achievements": 8,
        "email": "user@example.com",
        "email_verified": true,
        "allow_nsfw": false,
        "show_nsfw_media": false,
        "email_notifications": true,
        "email_promotions": false
    }
}
```

```json
{
    "data": {
        "name": "LunarLandr",
        "biography": "Retro gaming enthusiast",
        "avatar_url": "https://cdn.imgchest.com/files/avatar/lunar_avatar.png",
        "posts": 247,
        "comments": 89,
        "favorites": 156,
        "post_views": "87500",
        "created": "2019-09-25T01:00:45.000000Z",
        "experience": {
            "points": 950,
            "level": 12
        },
        "achievements": 5
    }
}
```

--------------------------------

### POST https://api.imgchest.com/v1/post/{id}/favorite

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Either adds or removes a post from the user's favorites.

```APIDOC
## POST https://api.imgchest.com/v1/post/{id}/favorite

### Description
Either adds or removes a post from the user's favorites.

### Method
POST

### Endpoint
https://api.imgchest.com/v1/post/{id}/favorite

### Parameters
#### Path Parameters
- **id** (string) - Required - The post id.

### Response
#### Success Response (200)
- **success** (string) - Indicates if the operation was successful.
- **message** (string) - Status message regarding the favorite action.
```

--------------------------------

### PUT or PATCH /v1/post/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Updates the details of a specific post identified by its ID. Only posts created by the authenticated user can be updated.

```APIDOC
## PUT or PATCH /v1/post/{id}

### Description
Allows you to update details for a post. You may only update posts that you created.

### Method
PUT or PATCH

### Endpoint
https://api.imgchest.com/v1/post/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the post.

#### Request Body
- **title** (string) - Optional - The title of the post.
- **privacy** (string) - Optional - The privacy setting of your post. Values are public, hidden or secret.
- **nsfw** (boolean) - Optional - This parameter can be true or false.

### Response
#### Success Response (200)
- **data** (object) - The updated post object containing id, title, username, privacy, report_status, views, nsfw, image_count, created, and images.

#### Response Example
{
    "data": {
        "id": "3qe4gdvj4j2",
        "title": "Donkey Kong - Video Game From The Mid 80's",
        "username": "LunarLandr",
        "privacy": "public",
        "report_status": 1,
        "views": 198,
        "nsfw": 0,
        "image_count": 4,
        "created": "2019-11-03T00:36:00.000000Z",
        "images": [
            {
                "id": "nw7w6cmlvye",
                "description": "Released in the arcades in 1981, Donkey Kong...",
                "link": "https://cdn.imgchest.com/files/nw7w6cmlvye.png",
                "position": 1,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "kwye3cpag4b",
                "description": null,
                "link": "https://cdn.imgchest.com/files/kwye3cpag4b.png",
                "position": 2,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "5g4z9c8ok72",
                "description": null,
                "link": "https://cdn.imgchest.com/files/5g4z9c8ok72.png",
                "position": 3,
                "created": "2019-11-03T00:36:00.000000Z"
            },
            {
                "id": "we4gdcv5j4r",
                "description": null,
                "link": "https://cdn.imgchest.com/files/we4gdcv5j4r.jpg",
                "position": 4,
                "created": "2019-11-03T00:36:00.000000Z"
            }
        ]
    }
}
```

--------------------------------

### Favorite A Post Response

Source: https://imgchest.com/docs/api/1.0/endpoints/post

The JSON response returned after toggling the favorite status of a post.

```json
{
    "success": "true",
    "message": "Favorite added."
}
```

--------------------------------

### DELETE https://api.imgchest.com/v1/post/{id}

Source: https://imgchest.com/docs/api/1.0/endpoints/post

Deletes a post and all associated files, comments, and ratings. You may provide either the post id or deletion url id.

```APIDOC
## DELETE https://api.imgchest.com/v1/post/{id}

### Description
Deletes a post and all associated files, comments, and ratings. You may provide either the post id or deletion url id.

### Method
DELETE

### Endpoint
https://api.imgchest.com/v1/post/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The post id or deletion url id.

### Response
#### Success Response (200)
- **success** (string) - Indicates if the operation was successful.
```
Tokens:
Raw