mr-smithers-excellent / api-documentation

This is the 500px API documentation.

500px API

500px API provides programmatic access to 500px functionality and content. Version 1 of the API is limited to the essentials of the website's functionality: viewing feature streams, photo information and comments, as well as user profiles.

The API is REST API and uses OAuth 1.0a for user authentication purposes. Currently, return format for all endpoints is JSON.

You can try our API in console (http://bitly.com/api500px)

See status.500px.com for API status updates, outages, and scheduled maintenance.

---

Checklist

• Try the API console
• See if the concepts used by the API are familiar to you
• Familiarize yourself with API functionality
• Read the 500px API Terms of Use
• Register your application and get OAuth consumer key and secret
• Hack away

---

Basics

• Formats and Terms
• API Terms of Use

Examples

• JavaScript
• iOS
• Ruby
• PHP

Changes

• 2014-03-27 Deprecated photo object's image_url key.

SDK

• JavaScript
• Android
• iOS

Endpoints

Photo Resources

• GET photos
• GET photos/search
• GET photos/:id
• GET photos/:id/comments
• GET photos/:id/votes
• PUT photos/:id
• POST photos
• POST photos/upload
• POST photos/:id/vote
• DELETE photos/:id/vote
• POST photos/:id/tags
• POST photos/:id/comments
• POST photos/:id/report
• DELETE photos/:id
• DELETE photos/:id/tags

Upload Method

• POST upload

User Resources

• GET users
• GET users/show
• GET users/:id/friends
• GET users/:id/followers
• GET users/search
• POST users/:id/friends
• DELETE users/:id/friends

Gallery Resources

• GET users/:user_id/galleries
• GET users/:user_id/galleries/:id
• GET users/:user_id/galleries/:id/items
• GET users/:user_id/galleries/:id/share_url
• PUT users/:user_id/galleries/:id
• PUT users/:user_id/galleries/:id/items
• PUT users/:user_id/galleries/reposition
• POST users/:user_id/galleries
• DELETE users/:user_id/galleries/:id

Collections/Sets Resources

• DEPRECATED. Please use Gallery Resources instead

Comment Resources

• POST comments/:id/comments

Authentication

• POST oauth/request_token
• POST oauth/authorize
• POST oauth/access_token
• Upload key

FAQ

What do I need to know before I start using the API?

Got rust on your skills? No worries. Here are the docs you might need to get started:

• HTTPS protocol
• REST software pattern
• Authentication with OAuth (or the official Beginner’s Guide)
• Data serialization with JSON (or see a quick tutorial)

How do I connect to the 500px.com API?

The API is only available to authenticated clients. Clients should authenticate users using OAuth. Once authenticated, you need to request a resource from one of the endpoints using HTTPS. Generally, reading any data is done through a request with GET method. If you want our server to create, update or delete a given resource, POST or PUT methods are required.

What return formats do you support?

500px API currently returns data in JSON format.

What kind of authentication is required?

Applications must identify themselves to access any resource. If your application only needs read-only access and does not authenticate the user, consumer_key containing a valid Consumer Key parameter should be specified in the query string. Otherwise, OAuth or upload key authentication takes care of identifying the application as well as the user accessing the API.

Is there a request rate limit?

There is a rate limit of 1,000,000 API requests per month per account. We will contact you and if required disable your application if we find that your application is exceeding this limit or interfering with our system's stability.This revised rate limit will come into effect May 1, 2014.