Flattr Developer Platform

Users

The User object

FieldTypePermissionDescription
idstringA unique identifier.
typestringObject type, set to user.
resourcestringURL to the API resource
linkstringURL to user on Flattr.com website
usernamestringUsername on Flattr
urlstringURL set by the user
firstnamestring
lastnamestring
avatarstringURL to a Flattr avatar, size: 48x48px
aboutstringShort description about the user
citystring
countrystring
active_supporterint1 if user can flattr
emailstringemail, extendedread
registered_atintextendedreadFormat is unixtime

The Mini User object

FieldTypePermissionDescription
typestringObject type, set to user.
resourcestringURL to the API resource
linkstringURL to user on Flattr.com website
idstringA unique identifier.
usernamestringUsername on Flattr

Get a user

Request
GET https://api.flattr.com/rest/v2/users/:username
Example response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Current: 1
X-RateLimit-Reset: 1342521939
{
  "type": "user",
  "resource": "https://api.flattr.com/rest/v2/users/flattr",
  "link": "https://flattr.com/profile/flattr",
  "id": "3bpQBK",
  "username": "flattr",
  "firstname": "Flattr.com",
  "lastname": "",
  "avatar": "",
  "about": "This is the official Flattr account. We made this site :)",
  "city": "",
  "country": "",
  "active_supporter": 1,
  "url": "http://flattr.com"
}
Errors

Get the authenticated user

Authorization needed

Request
GET https://api.flattr.com/rest/v2/user
Example response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Current: 1
X-RateLimit-Reset: 1342521939
{
  "type": "user",
  "resource": "https://api.flattr.com/rest/v2/users/flattr",
  "link": "https://flattr.com/profile/flattr",
  "id": "3bpQBK",
  "username": "flattr",
  "firstname": "Flattr.com",
  "lastname": "",
  "avatar": "",
  "about": "This is the official Flattr account. We made this site :)",
  "city": "",
  "country": "",
  "active_supporter": 1,
  "url": "http://flattr.com"
}
Errors
Response with scope extendedread
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Current: 1
X-RateLimit-Reset: 1342521939
{
  "type": "user",
  "resource": "https://api.flattr.com/rest/v2/users/flattr",
  "link": "https://flattr.com/profile/flattr",
  "id": "3bpQBK",
  "username": "flattr",
  "firstname": "Flattr.com",
  "lastname": "",
  "avatar": "",
  "about": "This is the official Flattr account. We made this site :)",
  "city": "",
  "country": "",
  "active_supporter": 1,
  "url": "http://flattr.com",
  "email": "info@flattr.com",
  "registered_at": 1270166816
}
Visit Flattr.com to learn more about Flattr.