NAV
cURL

Introduction

Welcome to the official Littlstar V1 API documentation!

NOTE: As of 4/13/2016 the Littlstar V1 API is deprecated. More information.

The following sections describe the features and functionality currently supported by our RESTful API.

If you come across any errors or bugs that you think we should know about, or if you’d just like to reach out and let us know how we’re doing and what you’d like to see added and/or improved, please contact us directly.

Authentication

To authenticate your request, include your API key in an X-Apikey header:

curl -H "X-Apikey: a1b2c3d4e5f6g7h8i9j" "endpoint"

Make sure to replace a1b2c3d4e5f6g7h8i9j with your actual API key.

Most of the Littlstar API offers read-only access to available resources (videos, photos, users, etc). However, there are interactive endpoints that require a user to be authenticated before access can be granted.

Littlstar uses an API key based system to grant authenticated access to users of our API. Upon successful registration a random API key is generated for every user and can be retrieved from the bottom of your settings page after logging in.

Search

Search All

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/search?q=dance
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    "SINGLE_VIDEO",
    "SINGLE_PHOTO",
    "SINGLE_USER",
    "SINGLE_CHANNEL"
  ]
}

Returns a paginated array of videos, photos, users, and channels matching the search query.

HTTP Request

GET https://littlstar.com/api/v1/search?q=

Query Parameters

Parameter Default Description
q search query
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
400 You must provide a search term!
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/search/videos?q=dance
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos matching the search query.

HTTP Request

GET https://littlstar.com/api/v1/search/videos?q=

Query Parameters

Parameter Default Description
q search query
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
400 You must provide a search term!
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/search/photos?q=dance
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos matching the search query.

HTTP Request

GET https://littlstar.com/api/v1/search/photos?q=

Query Parameters

Parameter Default Description
q search query
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
400 You must provide a search term!
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/search/users?q=john
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "user",
      "slug": "jsmith",
      "username": "jsmith",
      "first_name": "John",
      "last_name": "Smith",
      "bio": "",
      "avatar_url": "",
      "featured": "true|false",
      "verified": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "videos_count": 0,
      "photos_count": 0,
      "channels_count": 0,
      "full_name": "John Smith",
      "followers_count": 0,
      "following_count": 0,
      "following": "true|false",
      "interests": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ]
    },
    {}
  ]
}

Returns a paginated array of all users matching the search query.

HTTP Request

GET https://littlstar.com/api/v1/search/users?q=

Query Parameters

Parameter Default Description
q search query
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
400 You must provide a search term!
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/search/channels?q=dance
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 2,
      "type": "channel",
      "slug": "a1b2c3d4",
      "name": "360 Shades of Grey",
      "description": "",
      "sponsored": "true|false",
      "featured": "true|false",
      "visibility": "visible|hidden",
      "videos_count": 42,
      "photos_count": 42,
      "poster_url": "",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all channels matching the search query.

HTTP Request

GET https://littlstar.com/api/v1/search/channels?q=

Query Parameters

Parameter Default Description
q search query
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
400 You must provide a search term!

Users

Single User

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "id": 1,
    "type": "user",
    "slug": "jsmith",
    "username": "jsmith",
    "first_name": "John",
    "last_name": "Smith",
    "bio": "",
    "avatar_url": "",
    "featured": "true|false",
    "verified": "true|false",
    "created_at": "1979-04-13T04:20:00.778-04:20",
    "updated_at": "1979-04-13T04:20:00.778-04:20",
    "videos_count": 0,
    "photos_count": 0,
    "channels_count": 0,
    "full_name": "John Smith",
    "followers_count": 0,
    "following_count": 0,
    "following": "true|false",
    "interests": [
      {},
      {
        "id": 2,
        "slug": "sports",
        "name": "Sports",
        "image_url": ""
      },
      {}
    ]
  }
}

Returns the publicly available details for the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

User Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1/videos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos created by the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id/videos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

User Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1/photos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos created by the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id/photos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

User Channels

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1/channels
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 2,
      "type": "channel",
      "slug": "a1b2c3d4",
      "name": "360 Shades of Grey",
      "description": "",
      "sponsored": "true|false",
      "featured": "true|false",
      "visibility": "visible|hidden",
      "videos_count": 42,
      "photos_count": 42,
      "poster_url": "",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all channels created by the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id/channels

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

Followers

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1/followers
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "user",
      "slug": "jsmith",
      "username": "jsmith",
      "first_name": "John",
      "last_name": "Smith",
      "bio": "",
      "avatar_url": "",
      "featured": "true|false",
      "verified": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "videos_count": 0,
      "photos_count": 0,
      "channels_count": 0,
      "full_name": "John Smith",
      "followers_count": 0,
      "following_count": 0,
      "following": "true|false",
      "interests": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ]
    },
    {}
  ]
}

Returns a paginated array of all users that currently follow the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id/followers

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

Following

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/users/1/following
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "user",
      "slug": "jsmith",
      "username": "jsmith",
      "first_name": "John",
      "last_name": "Smith",
      "bio": "",
      "avatar_url": "",
      "featured": "true|false",
      "verified": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "videos_count": 0,
      "photos_count": 0,
      "channels_count": 0,
      "full_name": "John Smith",
      "followers_count": 0,
      "following_count": 0,
      "following": "true|false",
      "interests": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ]
    },
    {}
  ]
}

Returns a paginated array of all users currently followed by the requested user.

HTTP Request

GET https://littlstar.com/api/v1/users/:id/following

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find User with ‘id’=

Follow

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/users/1/follow
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Successfully started following user",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Start following the requested user.

HTTP Request

POST https://littlstar.com/api/v1/users/:id/follow

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find User with ‘id’=

Unfollow

curl -i -XDELETE -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/users/1/follow
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Successfully stopped following user",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Stop following the requested user.

HTTP Request

DELETE https://littlstar.com/api/v1/users/:id/follow

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find User with ‘id’=

Videos

All Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos.

HTTP Request

GET https://littlstar.com/api/v1/videos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos/sponsored
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all sponsored videos.

HTTP Request

GET https://littlstar.com/api/v1/videos/sponsored

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos/featured
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

This endpoint returns a paginated array of all featured videos.

HTTP Request

GET https://littlstar.com/api/v1/videos/featured

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Latest Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos/latest
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all latest videos.

HTTP Request

GET https://littlstar.com/api/v1/videos/latest

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

VR Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos/vr
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

This endpoint returns a paginated array of all videos that have been identified as optimized for display in Oculus Rift, GearVR, and other Head Mounted Displays.

HTTP Request

GET https://littlstar.com/api/v1/videos/vr

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Single Video

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/videos/1
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "id": 1,
    "type": "video",
    "slug": "a1b2c3d4",
    "title": "360 Degrees of Separation",
    "description": "",
    "visibility": "visible|hidden",
    "sponsored": "true|false",
    "featured": "true|false",
    "vr_optimized": "true|false",
    "duration": 0,
    "views": 0,
    "download": "true|false",
    "stars": 0,
    "stared": "true|false",
    "created_at": "1979-04-13T04:20:00.778-04:20",
    "updated_at": "1979-04-13T04:20:00.778-04:20",
    "hashtag_list": ["array", "of", "hashtags"],
    "categories": [
      {},
      {
        "id": 2,
        "slug": "sports",
        "name": "Sports",
        "image_url": ""
      },
      {}
    ],
    "flags": [
      {},
      {
        "id": 2,
        "reason": "inappropriate",
        "user": {
          "id": 1,
          "slug": "jsmith",
          "username": "jsmith",
          "featured": "true|false",
          "verified": "true|false",
          "avatar_url": ""
        }
      },
      {}
    ],
    "versions": {
      "web": "",
      "mobile": "",
      "webm": "",
      "vr": "",
      "download": ""
    },
    "posters": {
      "web": "",
      "mobile": "",
      "small": ""
    },
    "banners": {
      "large": "",
      "medium": "",
      "small": "",
      "thumbnail": ""
    },
    "user": {
      "id": 1,
      "slug": "jsmith",
      "username": "jsmith",
      "featured": "true|false",
      "verified": "true|false",
      "avatar_url": ""
    }
  }
}

Returns the details for the requested video.

HTTP Request

GET https://littlstar.com/api/v1/videos/:id

Error Responses

Code Message
404 Couldn’t find Video with ‘id’=
403 Video is currently encoding
403 Video has been deleted
403 Video is not available
403 Video is currently hidden

Star Video

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/videos/1/star
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Star Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Star the requested video.

HTTP Request

POST https://littlstar.com/api/v1/videos/:id/star

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find Video with ‘id’=

Unstar Video

curl -i -XDELETE -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/videos/1/star
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Unstar Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Unstar the requested video.

HTTP Request

DELETE https://littlstar.com/api/v1/videos/:id/star

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find Video with ‘id’=

Flag Video

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"flag\":{\"reason\":\"\"}}" https://littlstar.com/api/v1/videos/1/flag
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Flag Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Flag the requested video.

HTTP Request

POST https://littlstar.com/api/v1/videos/:id/flag

Query Parameters

Parameter Default Description
flag[reason] inappropriate or copyright

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 param is missing or the value is empty: flag
400 You must provide a reason!
400 Reason can only be inappropriate or copyright.
400 You have already flagged this video for that reason!
404 Couldn’t find Video with ‘id’=

Unflag Video

curl -i -XDELETE -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"flag\":{\"reason\":\"\"}}" https://littlstar.com/api/v1/videos/1/flag
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Unflag Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Unflag the requested video.

HTTP Request

DELETE https://littlstar.com/api/v1/videos/:id/flag

Query Parameters

Parameter Default Description
flag[reason] inappropriate or copyright

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 param is missing or the value is empty: flag
400 You must provide a reason!
400 Reason can only be inappropriate or copyright.
400 You have already flagged this video for that reason!
404 Couldn’t find Video with ‘id’=

Video Comments

curl -i https://littlstar.com/api/v1/videos/1/comments
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "body": "Help - I'm trapped in an example API response and I can't get out!!",
      "type": "comment",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all comments on the requested video.

HTTP Request

GET https://littlstar.com/api/v1/videos/:id/comments

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Video with ‘id’=

Video Comment

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"comment\":{\"body\":\"\"}}" https://littlstar.com/api/v1/videos/1/comment
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Comment Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Comment on the requested video.

HTTP Request

POST https://littlstar.com/api/v1/videos/:id/comment

Query Parameters

Parameter Default Description
comment[body] comment body

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 Missing required comment parameter
400 Body can’t be blank
404 Couldn’t find Video with ‘id’=

Photos

All Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/photos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos.

HTTP Request

GET https://littlstar.com/api/v1/photos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page
curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/photos/featured
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

This endpoint returns a paginated array of all featured photos.

HTTP Request

GET https://littlstar.com/api/v1/photos/featured

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Latest Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/photos/latest
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all latest photos.

HTTP Request

GET https://littlstar.com/api/v1/photos/latest

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

VR Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/photos/vr
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

This endpoint returns a paginated array of all photos that have been identified as optimized for display in Oculus Rift, GearVR, and other Head Mounted Displays.

HTTP Request

GET https://littlstar.com/api/v1/photos/vr

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Single Photo

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/photos/1
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "id": 1,
    "type": "photo",
    "slug": "a1b2c3d4",
    "title": "360 Degrees of Separation",
    "description": "",
    "visibility": "visible|hidden",
    "featured": "true|false",
    "vr_optimized": "true|false",
    "views": 0,
    "stars": 0,
    "stared": "true|false",
    "created_at": "1979-04-13T04:20:00.778-04:20",
    "updated_at": "1979-04-13T04:20:00.778-04:20",
    "hashtag_list": ["array", "of", "hashtags"],
    "categories": [
      {},
      {
        "id": 2,
        "slug": "sports",
        "name": "Sports",
        "image_url": ""
      },
      {}
    ],
    "flags": [
      {},
      {
        "id": 2,
        "reason": "inappropriate",
        "user": {
          "id": 1,
          "slug": "jsmith",
          "username": "jsmith",
          "featured": "true|false",
          "verified": "true|false",
          "avatar_url": ""
        }
      },
      {}
    ],
    "versions": {
      "original": "",
      "large": "",
      "medium": "",
      "small": "",
      "thumbnail": ""
    },
    "user": {
      "id": 1,
      "slug": "jsmith",
      "username": "jsmith",
      "featured": "true|false",
      "verified": "true|false",
      "avatar_url": ""
    }
  }
}

Returns the details for the requested photo.

HTTP Request

GET https://littlstar.com/api/v1/photos/:id

Error Responses

Code Message
404 Couldn’t find Photo with ‘id’=
403 Photo is currently processing
403 Photo has been deleted
403 Photo is currently hidden

Star Photo

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/photos/1/star
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Star Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Star the requested photo.

HTTP Request

POST https://littlstar.com/api/v1/photos/:id/star

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find Photo with ‘id’=

Unstar Photo

curl -i -XDELETE -H 'X-Apikey: [REQUIRED_APIKEY]' https://littlstar.com/api/v1/photos/1/star
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Unstar Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Unstar the requested photo.

HTTP Request

DELETE https://littlstar.com/api/v1/photos/:id/star

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
404 Couldn’t find Photo with ‘id’=

Flag Photo

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"flag\":{\"reason\":\"\"}}" https://littlstar.com/api/v1/photos/1/flag
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Flag Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Flag the requested photo.

HTTP Request

POST https://littlstar.com/api/v1/photos/:id/flag

Query Parameters

Parameter Default Description
flag[reason] inappropriate or copyright

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 param is missing or the value is empty: flag
400 You must provide a reason!
400 Reason can only be inappropriate or copyright.
400 You have already flagged this photo for that reason!
404 Couldn’t find Photo with ‘id’=

Unflag Photo

curl -i -XDELETE -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"flag\":{\"reason\":\"\"}}" https://littlstar.com/api/v1/photos/1/flag
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Unflag Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Unflag the requested photo.

HTTP Request

DELETE https://littlstar.com/api/v1/photos/:id/flag

Query Parameters

Parameter Default Description
flag[reason] inappropriate or copyright

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 param is missing or the value is empty: flag
400 You must provide a reason!
400 Reason can only be inappropriate or copyright.
400 You have already flagged this photo for that reason!
404 Couldn’t find Photo with ‘id’=

Photo Comments

curl -i https://littlstar.com/api/v1/photos/1/comments
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "body": "Help - I'm trapped in an example API response and I can't get out!!",
      "type": "comment",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all comments on the requested photo.

HTTP Request

GET https://littlstar.com/api/v1/photos/:id/comments

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Photo with ‘id’=

Photo Comment

curl -i -XPOST -H 'X-Apikey: [REQUIRED_APIKEY]' -H 'Content-Type: application/json' -d "{\"comment\":{\"body\":\"\"}}" https://littlstar.com/api/v1/photos/1/comment
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": "Comment Successful",
    "data_count": null
  },
  "pagination": null,
  "data": []
}

Comment on the requested photo.

HTTP Request

POST https://littlstar.com/api/v1/photos/:id/comment

Query Parameters

Parameter Default Description
comment[body] comment body

Error Responses

Code Message
401 A valid apikey is required to access this endpoint
400 Missing required comment parameter
400 Body can’t be blank
404 Couldn’t find Photo with ‘id’=

Categories

All Categories

curl -i https://littlstar.com/api/v1/categories
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 2,
      "type": "category",
      "slug": "sports",
      "name": "Sports",
      "image_url": "",
      "videos_count": 42,
      "photos_count": 42,
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20"
    },
    {}
  ]
}

Returns a paginated array of all categories.

HTTP Request

GET https://littlstar.com/api/v1/categories

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Single Category

curl -i https://littlstar.com/api/v1/categories/1
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "id": 2,
    "type": "category",
    "slug": "sports",
    "name": "Sports",
    "image_url": "",
    "videos_count": 42,
    "photos_count": 42,
    "created_at": "1979-04-13T04:20:00.778-04:20",
    "updated_at": "1979-04-13T04:20:00.778-04:20"
  }
}

Returns the details for the requested category.

HTTP Request

GET https://littlstar.com/api/v1/categories/:id

Error Responses

Code Message
404 Couldn’t find Category with ‘id’=

Category Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/categories/1/videos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos in the requested category.

HTTP Request

GET https://littlstar.com/api/v1/categories/:id/videos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Category with ‘id’=

Category Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/categories/1/photos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos in the requested category.

HTTP Request

GET https://littlstar.com/api/v1/categories/:id/photos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Category with ‘id’=

Channels

All Channels

curl -i https://littlstar.com/api/v1/channels
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 2,
      "type": "channel",
      "slug": "a1b2c3d4",
      "name": "360 Shades of Grey",
      "description": "",
      "sponsored": "true|false",
      "featured": "true|false",
      "visibility": "visible|hidden",
      "videos_count": 42,
      "photos_count": 42,
      "poster_url": "",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all channels.

HTTP Request

GET https://littlstar.com/api/v1/channels

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Single Channel

curl -i https://littlstar.com/api/v1/channels/1
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "id": 2,
    "type": "channel",
    "slug": "a1b2c3d4",
    "name": "360 Shades of Grey",
    "description": "",
    "sponsored": "true|false",
    "featured": "true|false",
    "visibility": "visible|hidden",
    "videos_count": 42,
    "photos_count": 42,
    "poster_url": "",
    "created_at": "1979-04-13T04:20:00.778-04:20",
    "updated_at": "1979-04-13T04:20:00.778-04:20",
    "banners": {
      "large": "",
      "medium": "",
      "small": "",
      "thumbnail": ""
    },
    "user": {
      "id": 1,
      "slug": "jsmith",
      "username": "jsmith",
      "featured": "true|false",
      "verified": "true|false",
      "avatar_url": ""
    }
  }
}

Returns the details for the requested channel.

HTTP Request

GET https://littlstar.com/api/v1/channels/:id

Error Responses

Code Message
404 Couldn’t find Channel with ‘id’=
403 Channel is currently hidden

Channel Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/channels/1/videos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos in the requested channel.

HTTP Request

GET https://littlstar.com/api/v1/channels/:id/videos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Channel with ‘id’=
403 Channel is currently hidden

Channel Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/channels/1/photos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos in the requested channel.

HTTP Request

GET https://littlstar.com/api/v1/channels/:id/photos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Channel with ‘id’=
403 Channel is currently hidden

Hashtags

All Hashtags

curl -i https://littlstar.com/api/v1/hashtags
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "name": "#360selfie",
      "type": "hashtag",
      "videos_count": 0,
      "photos_count": 0,
      "total_count": 0
    },
    {}
  ]
}

Returns a paginated array of all hashtags.

HTTP Request

GET https://littlstar.com/api/v1/hashtags

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Single Hashtag

curl -i https://littlstar.com/api/v1/hashtags/360selfie
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": null
  },
  "pagination": null,
  "data": {
    "name": "#360selfie",
    "type": "hashtag",
    "videos_count": 0,
    "photos_count": 0,
    "total_count": 0
  }
}

Returns the details for the requested hashtag.

HTTP Request

GET https://littlstar.com/api/v1/hashtags/:id

Error Responses

Code Message
404 Couldn’t find Hashtag with ‘id’=

Hashtag Videos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/hashtags/360selfie/videos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "video",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "sponsored": "true|false",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "duration": 0,
      "views": 0,
      "download": "true|false",
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "web": "",
        "mobile": "",
        "webm": "",
        "vr": "",
        "download": ""
      },
      "posters": {
        "web": "",
        "mobile": "",
        "small": ""
      },
      "banners": {
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all videos with the requested hashtag.

HTTP Request

GET https://littlstar.com/api/v1/hashtags/:id/videos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Hashtag with ‘id’=

Hashtag Photos

curl -i -H 'X-Apikey: [OPTIONAL_APIKEY]' https://littlstar.com/api/v1/hashtags/360selfie/photos
{
  "meta": {
    "code": 200,
    "errors": null,
    "message": null,
    "data_count": 30
  },
  "pagination": {
    "total_pages": 1,
    "first_page": true,
    "last_page": true,
    "out_of_range": false,
    "previous_page": null,
    "current_page": 1,
    "next_page": null
  },
  "data": [
    {},
    {
      "id": 1,
      "type": "photo",
      "slug": "a1b2c3d4",
      "title": "360 Degrees of Separation",
      "description": "",
      "visibility": "visible|hidden",
      "featured": "true|false",
      "vr_optimized": "true|false",
      "views": 0,
      "stars": 0,
      "stared": "true|false",
      "created_at": "1979-04-13T04:20:00.778-04:20",
      "updated_at": "1979-04-13T04:20:00.778-04:20",
      "hashtag_list": ["array", "of", "hashtags"],
      "categories": [
        {},
        {
          "id": 2,
          "slug": "sports",
          "name": "Sports",
          "image_url": ""
        },
        {}
      ],
      "flags": [
        {},
        {
          "id": 2,
          "reason": "inappropriate",
          "user": {
            "id": 1,
            "slug": "jsmith",
            "username": "jsmith",
            "featured": "true|false",
            "verified": "true|false",
            "avatar_url": ""
          }
        },
        {}
      ],
      "versions": {
        "original": "",
        "large": "",
        "medium": "",
        "small": "",
        "thumbnail": ""
      },
      "user": {
        "id": 1,
        "slug": "jsmith",
        "username": "jsmith",
        "featured": "true|false",
        "verified": "true|false",
        "avatar_url": ""
      }
    },
    {}
  ]
}

Returns a paginated array of all photos with the requested hashtag.

HTTP Request

GET https://littlstar.com/api/v1/hashtags/:id/photos

Query Parameters

Parameter Default Description
page specific page of results
per_page 30 number of results per page

Error Responses

Code Message
404 Couldn’t find Hashtag with ‘id’=