{"__v":3,"_id":"564b867885e4e92b00fb4fa9","category":{"__v":9,"_id":"564b855b766d4923004e1fd1","pages":["564b863dae154821005080cb","564b86484f06ef2b006b08b8","564b865785e4e92b00fb4fa7","564b866bdda79a19000f2677","564b867885e4e92b00fb4fa9","56a9205d3c7e030d00797245","56a9206f1bb4420d004cac97","56a92093bd92180d00e1fc2e","56a92a13c48ee00d0092e2a2"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T19:51:55.701Z","from_sync":false,"order":11,"slug":"live-api","title":"Live API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","version":{"__v":17,"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T19:56:40.499Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"total\":795,\n   \"per_page\":10,\n   \"current_page\":1,\n   \"last_page\":80,\n   \"from\":1,\n   \"to\":10,\n   \"data\":[\n      {\n         \"user\":{\n            \"id\":20680082,\n            \"name\":\"World Triathlon\",\n            \"screen_name\":\"worldtriathlon\",\n            \"profile_image_url\":\"https:\\/\\/pbs.twimg.com\\/profile_images\\/378800000078714793\\/888c46aecbcd066ad99be9b5b7530224_normal.jpeg\",\n            \"verified\":true,\n            \"link\":\"https:\\/\\/twitter.com\\/worldtriathlon\"\n         },\n         \"tweet\":\"RT <a href=\\\"https:\\/\\/twitter.com\\/usatriathlon\\\" target=\\\"_blank\\\">:::at:::usatriathlon<\\/a>: Now accepting <a href=\\\"https:\\/\\/twitter.com\\/search?q=%23USATMemberCorner\\\" target=\\\"_blank\\\">#USATMemberCorner<\\/a> submissions for the spring issue of USA Triathlon Magazine: <a href=\\\"https:\\/\\/t.co\\/5uU6opaTON\\\" target=\\\"_blank\\\" rel=\\\"nofollow\\\">https:\\/\\/t.co\\/5uU6opaTON<\\/a> https\\u2026\",\n         \"id\":692048139386241025,\n         \"id_str\":\"692048139386241025\",\n         \"source\":\"<a href=\\\"http:\\/\\/twitter.com\\/download\\/iphone\\\" rel=\\\"nofollow\\\">Twitter for iPhone<\\/a>\",\n         \"created_at\":\"2016-01-26T18:15:08+0000\",\n         \"timestamp\":1453832108,\n         \"retweeted\":true,\n         \"retweeted_user\":{\n            \"id\":14630047,\n            \"name\":\"USA Triathlon\",\n            \"screen_name\":\"usatriathlon\",\n            \"profile_image_url\":\"https:\\/\\/pbs.twimg.com\\/profile_images\\/612604968\\/sqaure_1_USAT10LogoWO_normal.jpg\",\n            \"verified\":true,\n            \"link\":\"https:\\/\\/twitter.com\\/14630047\"\n         },\n         \"published\":true,\n         \"media\":\"https:\\/\\/pbs.twimg.com\\/media\\/CZqjnEwVAAA-fFA.jpg\"\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56a91e47c48ee00d0092e288","ref":"","in":"query","required":false,"desc":"How many tweets to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"56a91e47c48ee00d0092e287","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"56a91e47c48ee00d0092e286","ref":"","in":"query","required":false,"desc":"Only display tweets that have passed moderation","default":"true","type":"boolean","name":"published"},{"_id":"56a91e47c48ee00d0092e285","ref":"","in":"query","required":false,"desc":"Only show tweets published after the start_date","default":"","type":"datetime","name":"start_date"},{"_id":"56a91e47c48ee00d0092e284","ref":"","in":"query","required":false,"desc":"Only show tweets published before end_date","default":"","type":"datetime","name":"end_date"},{"_id":"56a91e47c48ee00d0092e283","ref":"","in":"query","required":false,"desc":"Exclude retweets from the results","default":"false","type":"boolean","name":"exclude_retweets"},{"_id":"56d7cb8db20d260b002655fd","ref":"","in":"query","required":false,"desc":"Exclude replies from the results","default":"false","type":"boolean","name":"exclude_replies"},{"_id":"56a91e47c48ee00d0092e282","ref":"","in":"query","required":false,"desc":"Restrict results to a specific Twitter screen_name","default":"","type":"string","name":"screen_name"},{"_id":"56a91e47c48ee00d0092e281","ref":"","in":"query","required":false,"desc":"Only return Tweets after this id","default":"","type":"int","name":"before"},{"_id":"56a91e47c48ee00d0092e280","ref":"","in":"query","required":false,"desc":"Only return Tweets before this id","default":"","type":"int","name":"after"},{"_id":"5774074d904b0c0e00ef06ad","ref":"","in":"query","required":false,"desc":"Filter Tweets for a word or hashtag","default":"","type":"string","name":"filter"}],"url":"/live/twitter"},"isReference":true,"order":4,"body":"The **Live Twitter Feed** method returns an array of live tweets related to a live event. This method should be used in conjunction with the [Twitter Streaming API](https://developers.triathlon.org/docs/twitter-stream) with users obtaining an initial state via this endpoint and then receiving future updates through the Streaming API.\n\nThe Twitter stream provides live text commentary of a race via @triathlonlive as well as returning event specific hashtags e.g. #WTSEdmonton. The Live Twitter Feed returns an array of Tweet objects which may be filtered to produce the desired outcome.\n\nWhere event hashtags are being used if the **published** parameter is set to **false** this will return an unfiltered list of all Tweets matching the hashtag. If you wish to use a moderated stream then using **published=true** will restrict to either approved accounts or moderated comments.","excerpt":"","slug":"live-twitter-feed","type":"endpoint","title":"Live Twitter Feed"}

getLive Twitter Feed


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many tweets to be returned per page
page:
integer
The page number to be returned
published:
booleantrue
Only display tweets that have passed moderation
start_date:
datetime
Only show tweets published after the start_date
end_date:
datetime
Only show tweets published before end_date
exclude_retweets:
booleanfalse
Exclude retweets from the results
exclude_replies:
booleanfalse
Exclude replies from the results
screen_name:
string
Restrict results to a specific Twitter screen_name
before:
integer
Only return Tweets after this id
after:
integer
Only return Tweets before this id
filter:
string
Filter Tweets for a word or hashtag

Result Format


Documentation

The **Live Twitter Feed** method returns an array of live tweets related to a live event. This method should be used in conjunction with the [Twitter Streaming API](https://developers.triathlon.org/docs/twitter-stream) with users obtaining an initial state via this endpoint and then receiving future updates through the Streaming API. The Twitter stream provides live text commentary of a race via @triathlonlive as well as returning event specific hashtags e.g. #WTSEdmonton. The Live Twitter Feed returns an array of Tweet objects which may be filtered to produce the desired outcome. Where event hashtags are being used if the **published** parameter is set to **false** this will return an unfiltered list of all Tweets matching the hashtag. If you wish to use a moderated stream then using **published=true** will restrict to either approved accounts or moderated comments.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}