Events

My dashboard
Get /v1.0/events.{_format}
Get the list of your new followers, donations, subscriptions and hostings in a list of events with their creation time, username and other custom information.

Requirements

Name Requirement Type Default Description
_format json|xml|html string json
apiKey string null
type follow|subscription|donation|hosting array null In a GET query, write your array like this: ?type[]=donation&type[]=subscription
offset integer 0
limit integer 10
sort createdAt|ref string createdAt
order asc|desc string desc
start datetime with timezone null
end datetime with timezone null

Code Example

curl -X GET "https://api.tipeeestream.com/v1.0/events.json?apiKey=your-api-key&type[]=donation&type[]=subscription

Response Example (json)


{
  "message": "success",
  "total_count": 151,
  "events": [
    {
      "id": 357246,
      "type": "subscription",
      "user": {
        "avatar": "5236",
        "country": "FR",
        "username": "lilelulo",
        "providers": [
          {
            "connectedAt": "2015-10-07T16:25:44+0200",
            "code": "twitch",
            "id": "36820986",
            "username": "lilelulo"
          }
        ],
        "created_at": "2015-09-04T18:31:47+0200",
        "session_at": "2015-09-04T18:31:47+0200"
      },
      "ref": "TWITCH_subscription_55f436032cd02",
      "inserted_at": "2015-09-12T16:26:11+0200",
      "created_at": "2015-09-12T16:26:11+0200",
      "parameters": {
        "resub": "0",
        "twitch_channel_id": "#lilelulo",
        "username": "greg"
      },
      "parameters.amount": 0
    },
    ...
  ]
}
Get /v1.0/events/chart.{_format}
Count your followers, donations, subscriptions and hostings grouped by days, weeks, months or years.

Requirements

Name Requirement Type Default Description
_format json|xml|html string json
apiKey string null
start date null
rangeType day|week|month|year string day

Code Example

curl -X GET "https://api.tipeeestream.com/v1.0/events/chart.json?apiKey=your-api-key&rangeType=week&start=2015-10-07

Response Example (json)

{
  "message": "success",
  "datas": {
  	"xAxis":[  
  		"Wednesday",
  		"Thursday",
  		"Friday",
  		"Saturday",
  		"Sunday",
  		"Monday",
  		"Tuesday"
  	],
  	"series": {
  		"Followers":{
  			"details":[0,0,0,0,0,0,0],
  			"total":0
  		},
  		"Subscriptions":{
  			"details":[0,0,0,0,0,0,0],
  			"total":0
  		},
  		"Donations":{
  			"details":[0,0,0,0,0,0,0],
  			"total":0
  		},
  		"Donations amount":{
  			"details":[0,0,0,0,0,0,0],
  			"total":0
  		}
  	}
  }
}
Get /v1.0/events/forever.{_format}
Get your total count for followers, donations, subscriptions and hostings.

Requirements

Name Requirement Type Default Description
_format json|xml|html string json
apiKey string null

Code Example

curl -X GET "https://api.tipeeestream.com/v1.0/events/forever.json?apiKey=your-api-key"

Response Example (json)

{  
  "message": "success",
  "datas": {
    "subscribers":0,
    "followers":7,
    "donations":3,
    "details":{  
        "hitbox":{  
            "subscribers":0,
            "followers":"7"
        }
    }
  }
}