Hatena::Grouphatenadeveloper

Flipnote Hatena JSON API

en/ugomemo/apis

Flipnote Hatena JSON API

Obsolete

※These APIs will not be available after Flipnote Hatena closes on 5/31/2013.

Data that can be acquired with this API

These APIs allow you to acquire data associated with your Flipnote Hatena account only such as Flipnotes, comments, favorite creators, and fans.

All of these APIs require the query parameter token which is an "authentication token", and will return JSON information only if the token matches the owner of the data which is being requested.

You can obtain your authentication token at: http://flipnote.hatena.com/my/setting

Flipnote Information

http://flipnote.hatena.com/${DSi ID}@DSi/movie/${FILENAME}.json?token={token}
HTTP MethodGET

Parameters

tokenDSi unique API authentication token

Response fields

uriURI of this Flipnote.
flv_uriURI of the FLV file.
3gp_uriURI of the 3GPP file.
ppm_uriURI of the PPM file.
thumbnail_uriURI of thumbnail images with sizes of 64x48, 128x96 and 256x192.
animation_gif_uriURI of animation GIFs with sizes of 128x96 and 192x144.
titleTitle of this Flipnote.
descriptionDescription of this Flipnote
authorAuthor information. The format is same as User Information API.
parentInformation about the parent Flipnote. This key has the value of an association array which contains uri and author.
play_countNumber of views.
download_countNumber of downloads.
star_countNumber of stars.
unique_star_countNumber of users who added stars.
comment_countNumber of comments.
regionRegion code.
created_onTime the Flipnote was uploaded. This key has the value of an association array which contains epoch.

Example

Errors

  • "404 Not Found" is returned if the user does not exist.
  • If no authentication token is provided, "400 Bad Request" is returned
  • If the authentication token does not match that of the data owner, "403 Forbidden" is returned

User Flipnotes

http://flipnote.hatena.com/${DSi ID}@DSi/movies.json?token={token}
HTTP MethodGET

This API has pagination. It returns 30 flipnotes per page.

Parameters

tokenDSi unique API authentication token
pagePage number to retrieve. The default value is 1.

Response fields

countThe total number of all Flipnotes by the user.
pagerpageCurrent page number.
total_pagesThe number of pages.
per_pageThe number of Flipnotes per page. This value is always 30.
prev_uriURI of the previous page. This is null if it doesn't exist.
next_uriURI of the next page. This is null if it doesn't exist.
moviesAn array of Flipnote Information.

Example

Errors

  • "404 Not Found" is returned if the user does not exist.
  • "400 Bad Request" is returned when /${Hatena ID}/movie.json is used (Use DSi ID instead).
  • If no authentication token is provided, "400 Bad Request" is returned.
  • If the authentication token does not match that of the data owner, "403 Forbidden" is returned.

Favorite Authors

http://flipnote.hatena.com/${DSi ID}@DSi/favorite_authors.json?token={token}
HTTP MethodGET

This API has pagination. It returns 30 users per page.

Parameters

tokenDSi unique API authentication token
pagePage number to retrieve. The default value is 1.

Response fields

countA number of favorite authors.
pagerpageCurrent page number.
total_pagesA number of pages.
per_pageA number of users per page. This value is always 30.
prev_uriURI of the previous page. This is null if it doesn't exist.
next_uriURI of the next page. This is null if it doesn't exist.
authorsAn array of User Informations.

Example

Errors

  • "404 Not Found" is returned if the user does not exist.
  • If no authentication token is provided, "400 Bad Request" is returned.
  • If the authentication token does not match that of the data owner, "403 Forbidden" is returned.

Fans

http://flipnote.hatena.com/${DSi ID}@ID/fans.json?token={token}
HTTP MethodGET

This API has pagination. It returns 30 users per page.

Parameters

tokenDSi unique API authentication token
pagePage number to retrieve. The default value is 1.

Response fields

countThe number of fans.
pagerpageCurrent page number.
total_pagesThe number of pages.
per_pageThe number of users per page. This value is always 30.
prev_uriURI of the previous page. This is null if it does not exist.
next_uriURI of the next page. This is null if it does not exist.
authorsAn array of User Informations.

Example

Errors

  • "404 Not Found" is returned if the user does not exist.
  • If no authentication token is provided, "400 Bad Request" is returned.
  • If the authentication token does not match that of the data owner, "403 Forbidden" is returned.

Comments of a flipnote

You can acquire a list of comments posted on your Flipnotes.

http://flipnote.hatena.com/${DSi ID}@DSi/movie.comment/${FILENAME}.json?token={token}
HTTP MethodGET

This API has pagination. It returns 30 comments per page. Sorted by posted time in ascending order (the oldest comment is first).

Parameters

tokenDSi unique API authentication token
pagePage number to retrieve. The default value is 1.

Response fields

countThe number of comments.
pagerpageCurrent page number.
total_pagesThe number of pages.
per_pageThe number of comments per page. This value is always 30.
prev_uriURI of the previous page. This is null if it does not exist.
next_uriURI of the next page. This is null if it does not exist.
commentsAn array of "Comment Information". "Comment Information" is described below.

"Comment Information" is an association array which has 4 key-values.

authorAuthor of the comment. The format is same as User Information API.
bodyBody of the text comment. This key doesn't exist for quickmemo (hand drawn) comments.
thumbnailURI of quickmemo (hand drawn) images with sizes of 64x48, 128x96 and 256x192. This key does not exist for text comments.
created_onTime the comment was posted. This value is an association array which contains epoch.

Example

Errors

  • "404 Not Found" is returned if the user does not exist..
  • If no authentication token is provided, "400 Bad Request" is returned.
  • If the authentication token does not match that of the data owner, "403 Forbidden" is returned.

Related documents

Hatena Star entry API
Retrieve list of stars added to flipnotes and comments.
Hatena Message inbox/outbox API
Retrieve list and contents of notices.

Change history

  • May 31, 2013 Obsoleted
  • May 7, 2013 API was revised to allow only your own data to be acquired
  • April 12, 2013 API was temporarily stopped
  • April 11, 2013 API Published.