API Reference

Hummingbird's API lets applications retrieve information about anime and manage users' libraries. This reference document will help developers integrate Hummingbird with their own desktop, mobile and web applications.

Currently there are two different versions of the API in use:

API v1

This is the stable API that is already implemented in many applications. It is recommended to use API v1 for any long-running projects. Minor additions or bug fixes can be made, but all these changes are guaranteed to be backwards compatible.

Methods

• Anime
  • Get metadata by ID
  • Search by title
• Library
  • Get all entries
  • Add/Update entry
  • Remove entry
• User
  • Authenticate
  • Get information
  • Get activity feed
  • Get favorite anime

Structures

• Anime object
• Library entry object
• Favorite object
• User object
• User object (mini)
• Story object
• Substory object

API v2

This is the new version of the Hummingbird API that will provide a lot more information than API v1 once it's finished. Note that anything under API v2 is subject to change. Use at your own risk.

Methods

• Get metadata by ID

Structures

• Anime object

Technical notes

Identifiers

Each anime entry in Hummingbird's database has a unique ID and a human-friendly slug. In most cases, IDs and slugs can be used interchangeably. Note that while IDs are static, slugs may change over time.

Responses

All methods will return application/json bodies. If a request results in an error, its response body will be a JSON object explaining the reason:

{
  "error": "Invalid credentials"
}

Resources

• API category @ Hummingbird Forums
• Hummingbird API v1 @ Mashape (outdated)
• Hummingbird API v2 @ Mashape (outdated)