Flattr Check out this API Console for the Flattr API Check out this API Console for the API

Social micropayments.

List a users flattrs

Method URL

GET https://api.flattr.com/rest/v2/users/[Username]/flattrs.[Format]

Resource parameters - part of the request URL

// *

Suffix - the end of the request URL

. *
Response format

Query parameters

?count=
Number of records to receive (default: 30)
&page=
Page of results to retreive (first page is 1)

List the authenticated users flattrs

Method URL

GET https://api.flattr.com/rest/v2/user/flattrs.[Format]

Authentication

This method requires authentication via OAuth 2. Follow these steps to authenticate:

  1. Register a user at http://flattr.com/register (if you do not already have a user)
  2. Authorize APIHQ to have access to your data. This will load a new web page temporarily. Click here to start the authorization process.
  3. Once you have authorized APIHQ this page will be loaded again and you can use this API method.

Suffix - the end of the request URL

. *
Response format

Query parameters

?count=
Number of records to receive (default: 30)
&page=
Page of results to retreive (first page is 1)

List a users things

Method URL

GET https://api.flattr.com/rest/v2/users/[Username]/things.[Format]

Resource parameters - part of the request URL

// *

Suffix - the end of the request URL

. *
Response format

Query parameters

?count=
Number of records to receive (default: 30)
&page=
Page of results to retreive (first page is 1)

List a authenticated users things

Method URL

GET https://api.flattr.com/rest/v2/user/things.[Format]

Authentication

This method requires authentication via OAuth 2. Follow these steps to authenticate:

  1. Register a user at http://flattr.com/register (if you do not already have a user)
  2. Authorize APIHQ to have access to your data. This will load a new web page temporarily. Click here to start the authorization process.
  3. Once you have authorized APIHQ this page will be loaded again and you can use this API method.

Suffix - the end of the request URL

. *
Response format

Query parameters

?count=
Number of records to receive (default: 30)
&page=
Page of results to retreive (first page is 1)

Get a thing

Method URL

GET https://api.flattr.com/rest/v2/things/[ID].[Format]

Resource parameters - part of the request URL

// *

Suffix - the end of the request URL

. *
Response format

Get multiple things

Method URL

GET https://api.flattr.com/rest/v2/things.[Format]

Suffix - the end of the request URL

. *
Response format

Query parameters

?id=
A list of thing ids you want separated with a comma (,)

Check if a thing exists

Method URL

GET https://api.flattr.com/rest/v2/things/lookup.[Format]

Suffix - the end of the request URL

. *
Response format

Query parameters

?url=
The URL you want to lookup

Search things

Method URL

GET https://api.flattr.com/rest/v2/things/search.[Format]

Suffix - the end of the request URL

. *
Response format

Query parameters

?query=
Free text search string
&url=
Filter by URL
&tags=
Filter by tags, supports boolean syntax with | (OR), !(NOT) and & (AND). For example search all things containing the tag game or games but not software would yield game | games ! software
&language=
Filter by language, for example en_GB or sv_SE
&category=
Filter by categiry
&user=
Fiter by username
&sort=
Sort the search results
&count=
Number of records to receive (default: 30)
&page=
Page of results to retreive (first page is 1)
&url=
The URL you want to lookup

Get a user

Method URL

GET https://api.flattr.com/rest/v2/users/[Username].[Format]

Resource parameters - part of the request URL

//
For example "flattr"

Suffix - the end of the request URL

. *
Response format

Get the authenticated user

Basic information about the authenticated user. To get more detailed information the scope "extendedread" should be used when authenticating via OAuth (not possible via the console).

Method URL

GET https://api.flattr.com/rest/v2/user.[Format]

Authentication

This method requires authentication via OAuth 2. Follow these steps to authenticate:

  1. Register a user at http://flattr.com/register (if you do not already have a user)
  2. Authorize APIHQ to have access to your data. This will load a new web page temporarily. Click here to start the authorization process.
  3. Once you have authorized APIHQ this page will be loaded again and you can use this API method.

Suffix - the end of the request URL

. *
Response format

List an users activities

The default activities are outgoing activities, what the user has done. If you instead want to get a users incoming activities set the type parameter to incoming.

Method URL

GET https://api.flattr.com/rest/v2/users/[Username]/activities.[Format]

Resource parameters - part of the request URL

// *

Suffix - the end of the request URL

. *
Response format

Query parameters

?type=

List a authenticated users activities

The default activities are outgoing activities, what the authenticated user has done. If you instead want to get a users incoming activities set the type parameter to incoming.

Method URL

GET https://api.flattr.com/rest/v2/user/activities.[Format]

Authentication

This method requires authentication via OAuth 2. Follow these steps to authenticate:

  1. Register a user at http://flattr.com/register (if you do not already have a user)
  2. Authorize APIHQ to have access to your data. This will load a new web page temporarily. Click here to start the authorization process.
  3. Once you have authorized APIHQ this page will be loaded again and you can use this API method.

Suffix - the end of the request URL

. *
Response format

Query parameters

?type=

List categories

Fetch a list of all available categories.

Method URL

GET https://api.flattr.com/rest/v2/categories.[Format]

Suffix - the end of the request URL

. *
Response format

List all available languages

Method URL

GET https://api.flattr.com/rest/v2/languages.[Format]

Suffix - the end of the request URL

. *
Response format