Users

My dashboard
Get /v1.0/me.{_format}
Get the informations about the user with the given <code>access_token</code> or <code>apiKey</code>

Code Example

curl -X GET "https://api.tipeeestream.com/v1.0/me?access_token=your-access-token"

Response Example (json)

{
  "avatar":"479",
  "hasPayment":false,
  "currency":{"code":"EUR","symbol":"u20ac","label":"Euro","available":true},
  "country":"FR",
  "username":"lilelulo",
  "providers":[{"connectedAt":"2015-11-19T11:19:46+0100","code":"twitch","id":"XXXX","username":"lilelulo"}],
  "created_at":"2015-11-19T11:19:46+0100",
  "session_at":"2015-11-19T11:19:46+0100"
}
Get /v1.0/me/api.{_format}
Get the apiKey for the given user.

Code Example

curl -X GET "https://api.tipeeestream.com/v1.0/me/api?access_token=your-access-token"

Response Example (json)

{"apiKey":"XXXXXXXXXXXXX"}
Post /v1.0/users/{username}/events.{_format}
This endpoint allows you to post custom datas for your users. The feature enabled for now is to create events that will be listened by the widgets on your stream.

Requirements

Name Requirement Type Default Description
username string null
_format json|xml|html string json
apiKey string null
type follow|subscription|donation|hosting string null
params[username] array null Required if "type" parameter is "follow"
params[username, resub] array null Required if "type" parameter is "subscription"
params[username, amount, currency] array null Required if "type" parameter is "donation"
params[viewers, hostname] array null Required if "type" parameter is "hosting"

Code Example

curl -X POST "https://api.tipeeestream.com/v1.0/users/lilelulo/events.json --data "apiKey=your-api-key&type=hosting&params[viewers]=100&params[hostname]=manolozy"

Response Example (json)

{
  "message": "success",
  "event": {
    "id": 404506,
    "type": "follow",
    "user": {
      "avatar": false,
      "country": "FR",
      "username": "Foo",
      "providers": [
        {
          "connectedAt": "2015-09-24T12:02:07+0200",
          "code": "twitch",
          "id": "021331045",
          "username": "Foo"
        }
      ],
      "created_at": "2015-09-22T11:01:02+0200",
      "session_at": "2015-09-22T11:01:02+0200"
    },
    "ref": "simulation-5603e397c7a04",
    "inserted_at": "2015-09-24T13:50:47+0200",
    "deleted_at": "2015-09-24T13:50:47+0200",
    "created_at": "2015-09-24T13:50:47+0200",
    "parameters": {
      "username": "Bar"
    },
    "parameters.amount": 0
  }
}