Using the bitbucket REST APIs

You can use bitbucket's REST APIs to interact programmatically with a bitbucket repository, wiki, issue tracker and with other users.

The APIs are experimental and beta bitbucket's REST APIs are experimental at this stage. We will be adding to them in future releases. So please expect some API changes. We will be delighted if you use the APIs and give us your feedback via our issue tracker.

Introduction to bitbucket's REST APIs

bitbucket's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is JSON. If you wish, you can request XML or YAML instead of JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

bitbucket's APIs provide the following REST resources:

• Changesets
• Emails
• Events
• Followers
• Groups
• Groups Privileges
• Invitations
• Issue Comments
• Issues
• Privileges
• Repositories
• Services
• Source
• SSH Keys
• Users
• Wiki

Access the API via SSL

The bitbucket API works only over HTTPS.

Output Formats

By default, our API will speak JSON. You can use the '?format=' query string parameter to override this behaviour. JSON, XML and YAML emitters are available. For example, use following query string:

?format=yaml

Time zones

Any timestamp returned whose key contains "utc" is in Coordinated Universal Time. All other timestamps are in the local time of Amsterdam. Amsterdam timestamps are now deprecated. If you're using them in your application, please switch to the UTC equivalents.