This API documentation is inspired by the beautifully designed API of unsplash.
You can have quick links to important sections using those big squares. It is easy to use, simply add a markdown file in the thumbnails
section. Easy peezy!
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Create a list by starting a line with -
.
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
GET /random
None
200 OK
X-Ratelimit-Limit: 1000
X-Ratelimit-Remaining: 999
Note: To access a user’s private data, the user is required to authorize the read_user scope. Without it, this request will return a 403 Forbidden response.
Post /photo/
None
200 OK
X-Ratelimit-Limit: 1000
X-Ratelimit-Remaining: 999
Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
Create an enumerated list by starting a line with 1.
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
PUT /photo
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
None
{
"id": "pXhwzz1JtQU",
"updated_at": "2016-07-10T11:00:01-05:00",
"username": "jimmyexample",
"first_name": "James",
"last_name": "Example",
"twitter_username": "jimmy",
"portfolio_url": null,
"bio": "The user's bio",
"location": "Montreal, Qc",
"total_likes": 20,
"total_photos": 10,
"total_collections": 5,
"followed_by_user": false,
"downloads": 4321,
"uploads_remaining": 4,
"instagram_username": "james-example",
"location": null,
"email": "jim@example.com",
"links": {
"self": "https://api.unsplash.com/users/jimmyexample",
"html": "https://unsplash.com/jimmyexample",
"photos": "https://api.unsplash.com/users/jimmyexample/photos",
"likes": "https://api.unsplash.com/users/jimmyexample/likes",
"portfolio": "https://api.unsplash.com/users/jimmyexample/portfolio"
}
}
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
GET /statistics/:userid
Key | Description | |
---|---|---|
username |
optional | Username. |
first_name |
required | First name. |
url |
optional | Portfolio/personal URL. |
200 OK
X-Ratelimit-Limit: 1000
X-Ratelimit-Remaining: 999
{
// ...
"profile_image": {
"small": ...
"medium": ...
"large": ...
"custom": "https://images.unsplash.com/your-custom-image.jpg?q=80&fm=jpg&crop=faces&fit=crop&h=100&w=100"
}
}
Get the 5 best users.
GET /statistics/search
None
200 OK
X-Ratelimit-Limit: 1000
X-Ratelimit-Remaining: 999
{
// ...
"profile_image": {
"small": ...
"medium": ...
"large": ...
"custom": "https://images.unsplash.com/your-custom-image.jpg?q=80&fm=jpg&crop=faces&fit=crop&h=100&w=100"
}
}
If an error occurs, whether on the server or client side, the error message(s) will be returned in an errors array. For example:
422 Unprocessable Entity
{
"errors": ["Username is missing", "Password cannot be blank"]
}