12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574 |
- {
- "swagger": "2.0",
- "info": {
- "version": "1.1",
- "title": "Twitter REST API This is interesting in so many cases"
- },
- "host": "api.twitter.com",
- "basePath": "/1.1",
- "schemes": [
- "http",
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "securityDefinitions": {
- "oauth": {
- "type": "oauth2",
- "flow": "implicit",
- "authorizationUrl": "https://twitter.com/oauth/authorize/?client_id=CLIENT-ID&redirect_uri=REDIRECT-URI&response_type=token",
- "scopes": {
- "basic": "to read any and all data related to twitter this is interesting op\n"
- }
- }
- },
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "paths": {
- "/statuses/mentions_timeline": {
- "get": {
- "description": "Returns the 20 most recent mentions for the authenticating kkkkkkk user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "count",
- "in": "query",
- "description": "Specifies the number of tweets to try and retrieve",
- "required": false,
- "type": "string"
- },
- {
- "name": "since_id",
- "in": "query",
- "description": "Returns result with an ID greater than the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "Returns results with an ID less than or equal to the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- },
- {
- "name": "contributor_details",
- "in": "query",
- "description": "This parameter enhances the contributors element of the status response",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "The entities node will be disincluded when set to false",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- }
- },
- "/statuses/user_timeline": {
- "get": {
- "description": "Returns a collection of the most recent Tweets posted by the User",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "count",
- "in": "query",
- "description": "Specifies the number of tweets to try and rppetrieve",
- "required": false,
- "type": "string"
- },
- {
- "name": "since_id",
- "in": "query",
- "description": "Returns result with an ID greater than the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "Returns results with an ID less than or equal to the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- },
- {
- "name": "exclude_replies",
- "in": "query",
- "description": "This paramters will prevent from appearing in the returned timeline",
- "required": false,
- "type": "boolean"
- },
- {
- "name": "contributor_details",
- "in": "query",
- "description": "This paramters enhances the contributors element of the status response to include the screen_name of the contributor",
- "required": false,
- "type": "boolean"
- },
- {
- "name": "include_rts",
- "in": "query",
- "description": "When set to false, the timeline will strip any native retweet",
- "required": false,
- "type": "boolean"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- }
- },
- "/statuses/home_timeline": {
- "get": {
- "description": "Returns a collection of the most recent Tweets",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "since_id",
- "in": "query",
- "description": "Returns result with an ID greater than the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "Returns results with an ID less than or equal to the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- },
- {
- "name": "exclude_replies",
- "in": "query",
- "description": "This paramters will prevent from appearing in the returned timeline",
- "required": false,
- "type": "boolean"
- },
- {
- "name": "contributor_details",
- "in": "query",
- "description": "This paramters enhances the contributors element of the status response to include the screen_name of the contributor",
- "required": false,
- "type": "boolean"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- }
- },
- "/statuses/retweets/{id}": {
- "post": {
- "description": "Retweens a tweet",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The numerical ID of the desired status",
- "required": true,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- },
- "/statuses/show/{id}": {
- "get": {
- "description": "Retruns a single Tweet",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The numerical ID of the desired status",
- "required": true,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_my_retweet",
- "in": "query",
- "description": "When set to either true, t or 1, any Tweets returned that have been retweeted by the authenticating",
- "required": true,
- "type": "string"
- },
- {
- "name": "include_entities",
- "type": "string",
- "in": "query",
- "description": "The entities node will be disincluded when set to false",
- "required": false
- }
- ],
- "responses": {
- "200": {
- "description": "Success if that matters wd sw",
- "schema": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- },
- "/statuses/destroy/{id}": {
- "post": {
- "description": "Destroys the status specified by the required ID parameter",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The numerical ID of the desired status",
- "required": true,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- },
- "/statuses/update": {
- "post": {
- "description": "Updates the authenticating user's status",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "status",
- "in": "query",
- "description": "The text of your status update",
- "required": true,
- "type": "string"
- },
- {
- "name": "in_reply_to_status_id",
- "in": "query",
- "description": "The ID of an existing status",
- "required": false,
- "type": "string"
- },
- {
- "name": "lat",
- "in": "query",
- "description": "The latitude of the location",
- "required": false,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "The longitude of the location",
- "required": false,
- "type": "string"
- },
- {
- "name": "place_id",
- "in": "query",
- "description": "A place in the world",
- "required": false,
- "type": "string"
- },
- {
- "name": "display_coordinates",
- "in": "query",
- "description": "Whether or not to put a pin on the exact coordinates a tweet",
- "required": false,
- "type": "string"
- },
- {
- "name": "trim_user",
- "in": "query",
- "description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Tweets"
- }
- },
- "403": {
- "description": "Error"
- }
- }
- }
- },
- "/statuses/oembed": {
- "get": {
- "description": "Returns information allowing the creation of an embedded representation",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "query",
- "description": "The tweet/status id to return embed code for",
- "required": true,
- "type": "string"
- },
- {
- "name": "url",
- "in": "query",
- "description": "The encoded URL of the Tweet status to be embedded",
- "required": true,
- "type": "string"
- },
- {
- "name": "maxwidth",
- "in": "query",
- "description": "The maximum width in pixels that the embed should be rendered at",
- "required": false,
- "type": "string"
- },
- {
- "name": "hide_media",
- "in": "query",
- "description": "Specifies whether the embedded tweet should automatically show the original message in the case that the embedded Tweet is a reply",
- "required": false,
- "type": "string"
- },
- {
- "name": "hide_thread",
- "in": "query",
- "description": "Specifies whether the embedded Tweet html should include a 'script' element pointing to widgets.js",
- "required": false,
- "type": "string"
- },
- {
- "name": "align",
- "in": "query",
- "description": "Specifies whether the embedded Tweet should be left aligned",
- "required": false,
- "type": "string"
- },
- {
- "name": "related",
- "in": "query",
- "description": "A value for the TWT related parameters",
- "required": false,
- "type": "string"
- },
- {
- "name": "lang",
- "in": "query",
- "description": "Languages code for the rendered embed",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- },
- "/lists/list": {
- "get": {
- "description": "Return all lists the authenticating or specified user subscribes to, including their own.",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to return results for Hey jeremey ijikjkhj,kb kukj",
- "required": true,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The ID of the user for whom to return results for",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Lists"
- }
- }
- }
- }
- }
- },
- "/lists/statuses": {
- "get": {
- "description": "Returns a timeline of tweets authored by memebers of the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list by its slug instead of its numerical id",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "since_id",
- "in": "query",
- "description": "Returns results with an ID greater than the sepcified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "Returns results with an ID less than or equal to the specified ID",
- "required": false,
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "description": "Specifies the number of results to retrieve per page",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "Entities are ON by default",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_rts",
- "in": "query",
- "description": "When set to either true, t or 1, the list timeline will contain native retweets in addition to the standard stream of tweets",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- }
- },
- "/lists/members/destroy": {
- "get": {
- "description": "Returns the list of memebers destroy",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list by its slug instrad of its numerical id",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The is of the user who wons the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/lists/memberships": {
- "get": {
- "description": "Returns the lists of the specified user has been added to",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to return results for",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to return results for",
- "required": false,
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "Breaks the results into pages",
- "required": false,
- "type": "string"
- },
- {
- "name": "filter_to_owned_lists",
- "in": "query",
- "description": "When set to true, t or 1, will return just lists the authenticating user owns",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Cursor_lists"
- }
- }
- }
- }
- },
- "/lists/subscribers": {
- "get": {
- "description": "Returns the subscribers of the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list by its slug insted of its numerical id",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "the screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "Breaks the results into pages",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "Wehn set to either true, t or 1",
- "required": false,
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "When set to either true, t or 1",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Cursor_lists"
- }
- }
- }
- }
- },
- "/lists/subscribers/create": {
- "post": {
- "description": "Subscribes the authenticated user to the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "the screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Lists"
- }
- }
- }
- }
- },
- "/lists/subscribers/show": {
- "get": {
- "description": "Check if the specified user is a subscriber of the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The is of the user who wons the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "Wehn set to either true, t or 1",
- "required": false,
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "When set to either true, t or 1",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/lists/subscribers/destroy": {
- "get": {
- "description": "Returns list of subscribers destroy",
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "the screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/lists/members/create_all": {
- "get": {
- "description": "Returns lists of members create_all",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "the screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/list/members/show": {
- "get": {
- "description": "Check if the specified user is a member of the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "Wehn set to either true, t or 1",
- "required": false,
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "When set to either true, t or 1",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/list/members": {
- "get": {
- "description": "Returns the members of the specified list",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "Wehn set to either true, t or 1",
- "required": false,
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "When set to either true, t or 1",
- "required": false,
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "Breaks the results into pages",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/list/members/create": {
- "post": {
- "description": "Returns list of members create",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/lists/destroy": {
- "post": {
- "description": "Returns list of destroy",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Lists"
- }
- }
- }
- }
- },
- "/lists/update": {
- "post": {
- "description": "Returns lists of updates",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "name",
- "in": "query",
- "description": "The name for the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "mode",
- "in": "query",
- "description": "Whether your list is public or private",
- "required": false,
- "type": "string"
- },
- {
- "name": "description",
- "in": "query",
- "description": "The description to give the list",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/lists/create": {
- "post": {
- "description": "Returns list of create",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "name",
- "in": "query",
- "description": "The name for the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "mode",
- "in": "query",
- "description": "Whether your list is public or private",
- "required": false,
- "type": "string"
- },
- {
- "name": "description",
- "in": "query",
- "description": "The description to give the list",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Lists"
- }
- }
- }
- }
- },
- "/lists/show": {
- "get": {
- "description": "Returns list of show",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Lists"
- }
- }
- }
- }
- },
- "/lists/subscriptions": {
- "get": {
- "description": "Returns list of subscriptions",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user",
- "required": false,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to return results for",
- "required": false,
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "description": "The amount of results to return per page",
- "required": false,
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "Breaks the results into pages",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Cursor_lists"
- }
- }
- }
- }
- },
- "/list/members/destroy_all": {
- "get": {
- "description": "Returns lists of destroy all",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "list_id",
- "in": "query",
- "description": "The numerical id of the list",
- "required": true,
- "type": "string"
- },
- {
- "name": "slug",
- "in": "query",
- "description": "You can identify a list being requested by a slug",
- "required": true,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The id of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "The screen name of the user for whom to remove from the list",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_screen_name",
- "in": "query",
- "description": "The screen name of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- },
- {
- "name": "owner_id",
- "in": "query",
- "description": "The user ID of the user who owns the list being requested by a slug",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Cursor_lists"
- }
- }
- }
- }
- },
- "/direct_messages/sent": {
- "get": {
- "description": "return 20 most recent direct messages sent",
- "parameters": [
- {
- "name": "since_id",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Messages"
- }
- }
- }
- }
- }
- },
- "/direct_messages/show": {
- "get": {
- "description": "returns a single direct message specified by an id",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "query",
- "description": "ID of direct message",
- "type": "string",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Messages"
- }
- }
- }
- }
- }
- },
- "/search/tweets": {
- "get": {
- "description": "returns collection of relevant Tweets matching query",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "q",
- "in": "query",
- "description": "URL-encoded search query of 500 characters max",
- "type": "string",
- "required": true
- },
- {
- "name": "geocode",
- "in": "query",
- "description": "returns tweets by users located within given radius",
- "type": "string",
- "required": false
- },
- {
- "name": "lang",
- "in": "query",
- "description": "restricts tweets to a given language",
- "type": "string",
- "required": false
- },
- {
- "name": "locale",
- "in": "query",
- "description": "language of query you are sending",
- "type": "string",
- "required": false
- },
- {
- "name": "result_type",
- "in": "query",
- "description": "specifies type of search results you prefer",
- "type": "string",
- "required": false
- },
- {
- "name": "count",
- "in": "query",
- "description": "number of tweets to return",
- "type": "string"
- },
- {
- "name": "until",
- "in": "query",
- "description": "returns tweets created before given date",
- "type": "string"
- },
- {
- "name": "since_id",
- "in": "query",
- "description": "return results with ID greater than specified",
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "returns results with an ID less than/equal to specified ID",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "callback",
- "in": "query",
- "description": "response will use the callback with given name",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tweets"
- }
- }
- }
- }
- }
- },
- "/saved_searches/list": {
- "get": {
- "description": "Returns the authenticated user's saved search queries",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Query"
- }
- }
- }
- }
- }
- },
- "/saved_searches/show/{id}": {
- "get": {
- "description": "Retrieve the information for the saved search represented by the given id",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the saved search",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Query"
- }
- }
- }
- }
- },
- "/saved_searches/create": {
- "post": {
- "description": "Create a new saved search for the authenticated user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "query",
- "in": "query",
- "description": "The query of the search the user would like to save",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Query"
- }
- }
- }
- }
- },
- "/saved_searches/destroy/{id}": {
- "post": {
- "description": "Destroy a saved search for the authenticating user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the saved search",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Query"
- }
- }
- }
- }
- },
- "/direct_messages": {
- "get": {
- "description": "return 20 most recent direct messages sent to user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "since_id",
- "in": "query",
- "description": "return results with ID greater than specified",
- "type": "string"
- },
- {
- "name": "max_id",
- "in": "query",
- "description": "returns results with an ID less than/equal to specified ID",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include status",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Messages"
- }
- }
- }
- }
- }
- },
- "/direct_messages/destroy": {
- "post": {
- "description": "destroys direct messages specified in required ID",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "query",
- "description": "ID of direct message to delete",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Messages"
- }
- }
- }
- }
- },
- "/direct_messages/new": {
- "post": {
- "description": "sends a new direct message to specified user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "description": "description",
- "type": "string",
- "required": true
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user receiving message",
- "type": "string"
- },
- {
- "name": "text",
- "in": "query",
- "description": "text of your direct message",
- "type": "string",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Messages"
- }
- }
- }
- }
- },
- "/friends/ids": {
- "get": {
- "description": "returns a cursored collection of user IDs followed by user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user for whom to return results for",
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user for whom to return results for",
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "causes list of connections to be broken in pages",
- "type": "string"
- },
- {
- "name": "stringify_ids",
- "in": "query",
- "description": "IDs converted to strings",
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "description": "number of IDs to attempt retrieval of",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_ids"
- }
- }
- }
- }
- },
- "/followers/ids": {
- "get": {
- "description": "returns a cursored collection of user IDs following the user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user for whom to return results for",
- "type": "string"
- },
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user for whom to return results for",
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "causes list of connections to be broken in pages",
- "type": "string"
- },
- {
- "name": "stringify_ids",
- "in": "query",
- "description": "IDs converted to strings",
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "description": "number of IDs to attempt retrieval of",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_ids"
- }
- }
- }
- }
- },
- "/friendships/incoming": {
- "get": {
- "description": "returns collection of IDs of users with pending follow request",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "cursor",
- "in": "query",
- "description": "causes list of connections to be broken in pages",
- "type": "string"
- },
- {
- "name": "stringify_ids",
- "in": "query",
- "description": "IDs converted to strings",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_ids"
- }
- }
- }
- }
- },
- "/friendships/outgoing": {
- "get": {
- "description": "returns collection of IDs of users with pending follow request from the user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "cursor",
- "in": "query",
- "description": "causes list of connections to be broken in pages",
- "type": "string"
- },
- {
- "name": "stringify_ids",
- "in": "query",
- "description": "IDs converted to strings",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_ids"
- }
- }
- }
- }
- },
- "/friendships/create": {
- "post": {
- "description": "allows users to follow user sepcified by ID",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user for whom to befriend",
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user for whom to befriend",
- "type": "string"
- },
- {
- "name": "follow",
- "in": "query",
- "description": "enable notifications for target user",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/friendships/destroy": {
- "post": {
- "description": "allows user to unfollow user psecified by ID",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user for whom to befriend",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user for whom to befriend",
- "type": "string",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/friendships/update": {
- "post": {
- "description": "Allows one to enable or disable settings for specified user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user for whom to befriend",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user for whom to befriend",
- "type": "string",
- "required": true
- },
- {
- "name": "device",
- "in": "query",
- "description": "enable/disable device notifications for user",
- "type": "string",
- "required": true
- },
- {
- "name": "retweets",
- "in": "query",
- "description": "enable/disable retweets from target user",
- "type": "string",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Friendship"
- }
- }
- }
- }
- },
- "/friendships/show": {
- "get": {
- "description": "returns detailed info about relationship between two users",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "source_id",
- "in": "query",
- "description": "user id of subject user",
- "type": "string"
- },
- {
- "name": "source_screen_name",
- "in": "query",
- "description": "screen_name of subject user",
- "type": "string"
- },
- {
- "name": "target_id",
- "in": "query",
- "description": "user id of target user",
- "type": "string",
- "required": true
- },
- {
- "name": "target_screen_name",
- "in": "query",
- "description": "screen name of target user",
- "type": "string",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Friendship"
- }
- }
- }
- }
- },
- "/account/settings": {
- "get": {
- "summary": "returns settings for user",
- "description": "returns settings for user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- },
- "post": {
- "summary": "updates user's settings",
- "description": "updates user's settings",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "trend_location_woeid",
- "in": "query",
- "description": "the Yahoo! Where On Earth ID to user as defaul tend location",
- "type": "string"
- },
- {
- "name": "sleep_time_enabled",
- "in": "query",
- "description": "enables/disables sleep time, silencing notifications",
- "type": "string"
- },
- {
- "name": "start_sleep_time",
- "in": "query",
- "description": "the hour that sleep time should begin if enabled",
- "type": "string"
- },
- {
- "name": "end_sleep_time",
- "in": "query",
- "description": "the hour that sleep time should end if enabled",
- "type": "string"
- },
- {
- "name": "time_zone",
- "in": "query",
- "description": "timezone dates and times should be displayed in",
- "type": "string"
- },
- {
- "name": "lang",
- "in": "query",
- "description": "language which Twitter should render in for the user",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/account/update_delivery_device": {
- "post": {
- "summary": "sets which device Twitter delivers updates to for user",
- "description": "sets which device Twitter delivers updates to for user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "device",
- "in": "query",
- "description": "must be one of sms, none",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/account/update_profile": {
- "post": {
- "summary": "sets values that users ar eable to set under Account tab",
- "description": "sets values that users ar eable to set under Account tab",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "name",
- "in": "query",
- "description": "full name of profile",
- "type": "string"
- },
- {
- "name": "url",
- "in": "query",
- "description": "url associated with profile",
- "type": "string"
- },
- {
- "name": "location",
- "in": "query",
- "description": "city or country describing where user of account is.",
- "type": "string"
- },
- {
- "name": "description",
- "in": "query",
- "description": "a description of user owning account",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include statuses in response",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/account/update_profile_background_image": {
- "post": {
- "summary": "updates user's profile background image",
- "description": "updates user's profile background image",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "consumes": [
- "multipart/form-data"
- ],
- "parameters": [
- {
- "name": "tile",
- "in": "query",
- "description": "whether or not to tile background image",
- "type": "string"
- },
- {
- "name": "use",
- "in": "query",
- "description": "display background image or not",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include status in returned user objects",
- "type": "string"
- },
- {
- "name": "file",
- "in": "formData",
- "description": "image to replace background image of profile",
- "required": true,
- "type": "file"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/account/update_profile_colors": {
- "post": {
- "summary": "sets one or more hex values that controls color scheme",
- "description": "sets one or more hex values that controls color scheme",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "profile_background_color",
- "in": "query",
- "description": "profile background color",
- "type": "string"
- },
- {
- "name": "profile_link_color",
- "in": "query",
- "description": "profile link color",
- "type": "string"
- },
- {
- "name": "profile_sidebar_border_color",
- "in": "query",
- "description": "profile sidebar's border color",
- "type": "string"
- },
- {
- "name": "profile_sidebar_fill_color",
- "in": "query",
- "description": "profile's sidebar background color",
- "type": "string"
- },
- {
- "name": "profile_text_color",
- "in": "query",
- "description": "profile text color",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include statuses",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/account/update_profile_image": {
- "post": {
- "summary": "updates user's profile image",
- "description": "updates user's profile image",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "consumes": [
- "multipart/form-data"
- ],
- "parameters": [
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include statuses",
- "type": "string"
- },
- {
- "name": "image",
- "in": "formData",
- "description": "image to be set as profile image",
- "type": "file",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Settings"
- }
- }
- }
- }
- },
- "/blocks/list": {
- "get": {
- "summary": "disallows retweets and device notifications from a user",
- "description": "disallows retweets and device notifications from a user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to include statuses in response",
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "breaks block of user to be broken up into pages",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_users"
- }
- }
- }
- }
- },
- "/blocks/ids": {
- "get": {
- "summary": "returns array of numeric user ids of blocked users",
- "description": "returns array of numeric user ids of blocked users",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "stringify_ids",
- "in": "query",
- "description": "returns array of numeric IDs as string IDs",
- "type": "string"
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "breaks up block of user IDs into pages",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Cursor_users"
- }
- }
- }
- }
- },
- "/blocks/create": {
- "post": {
- "summary": "blocks the specified user",
- "description": "blocks the specified user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user to be blocked",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user to be blocked",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to skip statuses",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/blocks/destroy": {
- "post": {
- "summary": "un-blocks the specified user",
- "description": "un-blocks the specified user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user to be un-blocked",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user to be un-blocked",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to skip statuses",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/users/lookup": {
- "get": {
- "summary": "returns fully-hydrated user objects up to 100",
- "description": "returns fully-hydrated user objects up to 100",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user to lookup",
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user to lookup",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- }
- },
- "/users/show": {
- "get": {
- "summary": "returns a variety of info about specified user",
- "description": "returns a variety of info about specified user",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user to be shown",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user to be shown",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/users/search": {
- "get": {
- "summary": "simple relevance-based user search",
- "description": "simple relevance-based user search",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "q",
- "in": "query",
- "description": "the search query to run against people search",
- "type": "string",
- "required": true
- },
- {
- "name": "page",
- "in": "query",
- "description": "specifies the page of results to receive",
- "type": "string"
- },
- {
- "name": "count",
- "in": "query",
- "description": "number of people to return per page",
- "type": "string"
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- }
- },
- "/users/contributees": {
- "get": {
- "summary": "collection of users specified user can contribute to",
- "description": "collection of users specified user can contribute to",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user that is contributed to",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user to that is contributed to",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to skip statuses",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- }
- },
- "/users/contributors": {
- "get": {
- "summary": "collection of users that can contribute to specified account",
- "description": "collection of users that can contribute to specified account",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "screen name of user contributing",
- "type": "string",
- "required": true
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "ID of user contributing",
- "type": "string",
- "required": true
- },
- {
- "name": "include_entities",
- "in": "query",
- "description": "whether or not to include entities",
- "type": "string"
- },
- {
- "name": "skip_status",
- "in": "query",
- "description": "whether or not to skip statuses",
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- }
- },
- "/geo/id/{place_id}": {
- "get": {
- "description": "Returns all the information about a know place",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "place_id",
- "in": "path",
- "description": "A place in the world",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Places"
- }
- }
- }
- }
- }
- },
- "/geo/reverse_geoncode": {
- "get": {
- "description": "Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updatting a status",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "lat",
- "in": "query",
- "description": "The latitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "The longtitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "accuracy",
- "in": "query",
- "description": "A hint on region in which to search",
- "required": false,
- "type": "string"
- },
- {
- "name": "granularity",
- "in": "query",
- "description": "This is the minimal granularity of place types to return",
- "required": false,
- "type": "string"
- },
- {
- "name": "max_results",
- "in": "query",
- "description": "A hint as to the number of results to return",
- "required": false,
- "type": "string"
- },
- {
- "name": "callback",
- "in": "query",
- "description": "If supplied, the responses will use the JSON format with a callback of the given name",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Places"
- }
- }
- }
- }
- }
- },
- "/geo/search": {
- "get": {
- "description": "Search for places that can be attached to a statuses/updates",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "lat",
- "in": "query",
- "description": "The latitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "The longtitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "query",
- "in": "query",
- "description": "Free-form text to match against while executing a geo-based query",
- "required": true,
- "type": "string"
- },
- {
- "name": "ip",
- "in": "query",
- "description": "An Ip address",
- "required": true,
- "type": "string"
- },
- {
- "name": "accuracy",
- "in": "query",
- "description": "A hint on region in which to search",
- "required": false,
- "type": "string"
- },
- {
- "name": "granularity",
- "in": "query",
- "description": "This is the minimal granularity of place types to return",
- "required": false,
- "type": "string"
- },
- {
- "name": "contained_within",
- "in": "query",
- "description": "This is the place_id which you would like to restrict the search results to",
- "required": false,
- "type": "string"
- },
- {
- "name": "attribute:street_address",
- "in": "query",
- "description": "This parameter searches for places which have this givven street address",
- "required": false,
- "type": "string"
- },
- {
- "name": "callback",
- "in": "query",
- "description": "If supplied, the responses will use the JSON format with a callback of the given name",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Places"
- }
- }
- }
- }
- }
- },
- "/geo/similar_places": {
- "get": {
- "description": "Locates places near the given coordinates which are similar in name",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "lat",
- "in": "query",
- "description": "The latitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "The longtitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "name",
- "in": "query",
- "description": "The name a place is known as",
- "required": true,
- "type": "string"
- },
- {
- "name": "contained_within",
- "in": "query",
- "description": "This is the place_id which you would like to restrict the search results to",
- "required": false,
- "type": "string"
- },
- {
- "name": "attribute:street_address",
- "in": "query",
- "description": "This parameter searches for places which have this givven street address",
- "required": false,
- "type": "string"
- },
- {
- "name": "callback",
- "in": "query",
- "description": "If supplied, the responses will use the JSON format with a callback of the given name",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Places"
- }
- }
- }
- }
- }
- },
- "/geo/places": {
- "get": {
- "description": "Create a new place object at the given latitude and logitude",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "lat",
- "in": "query",
- "description": "The latitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "The longtitude to search around",
- "required": true,
- "type": "string"
- },
- {
- "name": "name",
- "in": "query",
- "description": "The name a place is known as",
- "required": true,
- "type": "string"
- },
- {
- "name": "token",
- "in": "query",
- "description": "The token found in the response from geo/similar_places",
- "required": true,
- "type": "string"
- },
- {
- "name": "contained_within",
- "in": "query",
- "description": "This is the place_id which you would like to restrict the search results to",
- "required": false,
- "type": "string"
- },
- {
- "name": "attribute:street_address",
- "in": "query",
- "description": "This parameter searches for places which have this givven street address",
- "required": false,
- "type": "string"
- },
- {
- "name": "callback",
- "in": "query",
- "description": "If supplied, the responses will use the JSON format with a callback of the given name",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Places"
- }
- }
- }
- }
- },
- "/trends/place": {
- "get": {
- "description": "Returns the top 10 trending topics for a specific WOEID",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "query",
- "description": "The yahoo where on earch id",
- "required": true,
- "type": "string"
- },
- {
- "name": "exclude",
- "in": "query",
- "description": "Setting this equal to hashtages will remove all hashtages from the trends list",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/TrendInfo"
- }
- }
- }
- }
- },
- "/trends/available": {
- "get": {
- "description": "Returns the availability",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Location"
- }
- }
- }
- }
- }
- },
- "/trends/closest": {
- "get": {
- "description": "Returns the location that Twitter has trending topic information for",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "lat",
- "in": "query",
- "description": "If provided with a long parameter the available trend locations wil be stored by distance",
- "required": true,
- "type": "string"
- },
- {
- "name": "long",
- "in": "query",
- "description": "If provided with a lat parameters the available trend locations will be sorted by distance",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Location"
- }
- }
- }
- }
- }
- },
- "/users/report_spam": {
- "post": {
- "description": "Returna users report spam",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "screen_name",
- "in": "query",
- "description": "The ID or screen_name of the user you want to report as a spammer",
- "required": false,
- "type": "string"
- },
- {
- "name": "user_id",
- "in": "query",
- "description": "The ID of the user you want to report as a spammer",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Users"
- }
- }
- }
- }
- },
- "/help/configuration": {
- "get": {
- "description": "Returns the current configuration used by Twitter including twitter.com slugs which are not usernames",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Help_Config"
- }
- }
- }
- }
- },
- "/help/languages": {
- "get": {
- "description": "Returns the list of languages supported by Twitter along with the language code supported by Twitter",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Help_Language"
- }
- }
- }
- }
- }
- },
- "/help/privacy": {
- "get": {
- "description": "Returns Twitter's privacy policy",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Help_Privacy"
- }
- }
- }
- }
- },
- "/help/tos": {
- "get": {
- "description": "Returns the Twitter Terms of Service",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/Help_Tos"
- }
- }
- }
- }
- },
- "/application/rate_limit_status": {
- "get": {
- "description": "Returns the current rate limits for methods belonging to the specified resource families",
- "security": [
- {
- "oauth": [
- "basic"
- ]
- }
- ],
- "parameters": [
- {
- "name": "resources",
- "in": "query",
- "description": "A comma-separated list of resource families you want to know the current rate limit disposition for",
- "required": false,
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- }
- },
- "definitions": {
- "Tweets": {
- "type": "object",
- "properties": {
- "contributors": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Contributors"
- }
- },
- "coordinates": {
- "$ref": "#/definitions/Coordinates"
- },
- "created_at": {
- "type": "string"
- },
- "current_user_retweet": {
- "$ref": "#/definitions/Tweets"
- },
- "entities": {
- "$ref": "#/definitions/Entities"
- },
- "favorite_count": {
- "type": "integer"
- },
- "favorited": {
- "type": "boolean"
- },
- "filter_level": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "in_reply_to_screen_name": {
- "type": "string"
- },
- "in_reply_to_status_id": {
- "type": "integer"
- },
- "in_reply_to_status_id_str": {
- "type": "string"
- },
- "in_reply_to_user_id": {
- "type": "integer"
- },
- "in_reply_to_user_id_str": {
- "type": "string"
- },
- "lang": {
- "type": "string"
- },
- "place": {
- "$ref": "#/definitions/Places"
- },
- "possibly_sensitive": {
- "type": "boolean"
- },
- "quoted_status_id": {
- "type": "integer"
- },
- "quoted_status_id_str": {
- "type": "string"
- },
- "quoted_status": {
- "$ref": "#/definitions/Tweets"
- },
- "scopes": {
- "type": "object",
- "additionalProperties": {}
- },
- "retweet_count": {
- "type": "integer"
- },
- "retweeted": {
- "type": "boolean"
- },
- "retweeted_status": {
- "$ref": "#/definitions/Tweets"
- },
- "source": {
- "type": "string"
- },
- "text": {
- "type": "string"
- },
- "truncated": {
- "type": "string"
- },
- "user": {
- "$ref": "#/definitions/Users"
- },
- "withheld_copyright": {
- "type": "boolean"
- },
- "withheld_countries": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "withheld_scope": {
- "type": "string"
- }
- }
- },
- "Contributors": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "screen_name": {
- "type": "string"
- }
- }
- },
- "Coordinates": {
- "type": "object",
- "properties": {
- "coordinates": {
- "type": "array",
- "items": {
- "type": "number"
- }
- },
- "type": {
- "type": "string"
- }
- }
- },
- "Users": {
- "type": "object",
- "properties": {
- "contributors_enabled": {
- "type": "boolean"
- },
- "created_at": {
- "type": "string"
- },
- "default_profile": {
- "type": "boolean"
- },
- "default_profile_image": {
- "type": "boolean"
- },
- "description": {
- "type": "string"
- },
- "entities": {
- "$ref": "#/definitions/Entities"
- },
- "favorites_count": {
- "type": "integer"
- },
- "follow_request_sent": {
- "type": "boolean"
- },
- "following": {
- "type": "boolean"
- },
- "followers_count": {
- "type": "integer"
- },
- "friends_count": {
- "type": "integer"
- },
- "geo_enabled": {
- "type": "boolean"
- },
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "is_translator": {
- "type": "boolean"
- },
- "lang": {
- "type": "string"
- },
- "listed_count": {
- "type": "integer"
- },
- "location": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "notifications": {
- "type": "boolean"
- },
- "profile_background_color": {
- "type": "string"
- },
- "profile_background_image_url": {
- "type": "string"
- },
- "profile_background_image_url_https": {
- "type": "string"
- },
- "profile_background_tile": {
- "type": "string"
- },
- "profile_banner_url": {
- "type": "string"
- },
- "profile_image_url": {
- "type": "string"
- },
- "profile_image_url_https": {
- "type": "string"
- },
- "profile_link_color": {
- "type": "string"
- },
- "profile_sidebar_border_color": {
- "type": "string"
- },
- "profile_sidebar_fill_color": {
- "type": "string"
- },
- "profile_text_color": {
- "type": "string"
- },
- "profile_use_background_image": {
- "type": "boolean"
- },
- "protected": {
- "type": "boolean"
- },
- "screen_name": {
- "type": "string"
- },
- "show_all_inline_media": {
- "type": "boolean"
- },
- "status": {
- "$ref": "#/definitions/Tweets"
- },
- "statuses_count": {
- "type": "integer"
- },
- "time_zone": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "utc_offset": {
- "type": "integer"
- },
- "verified": {
- "type": "boolean"
- },
- "withheld_in_countries": {
- "type": "string"
- },
- "withheld_scope": {
- "type": "string"
- }
- }
- },
- "Entities": {
- "type": "object",
- "properties": {
- "hashtags": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Hashtags"
- }
- },
- "media": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Media"
- }
- },
- "urls": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/URL"
- }
- },
- "user_mentions": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User_Mention"
- }
- }
- }
- },
- "Hashtags": {
- "type": "object",
- "properties": {
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "text": {
- "type": "string"
- }
- }
- },
- "Media": {
- "type": "object",
- "properties": {
- "display_url": {
- "type": "string"
- },
- "expanded_url": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "media_url": {
- "type": "string"
- },
- "media_url_https": {
- "type": "string"
- },
- "sizes": {
- "$ref": "#/definitions/Sizes"
- },
- "source_status_id": {
- "type": "integer"
- },
- "source_status_id_str": {
- "type": "integer"
- },
- "type": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "Size": {
- "type": "object",
- "properties": {
- "h": {
- "type": "integer"
- },
- "resize": {
- "type": "string"
- },
- "w": {
- "type": "integer"
- }
- }
- },
- "Sizes": {
- "type": "object",
- "properties": {
- "thumb": {
- "$ref": "#/definitions/Size"
- },
- "large": {
- "$ref": "#/definitions/Size"
- },
- "medium": {
- "$ref": "#/definitions/Size"
- },
- "small": {
- "$ref": "#/definitions/Size"
- }
- }
- },
- "URL": {
- "type": "object",
- "properties": {
- "display_url": {
- "type": "string"
- },
- "expanded_url": {
- "type": "string"
- },
- "indices": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "User_Mention": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "name": {
- "type": "string"
- },
- "screen_name": {
- "type": "string"
- }
- }
- },
- "Places": {
- "type": "object",
- "properties": {
- "attributes": {
- "type": "object",
- "additionalProperties": {}
- },
- "bounding_box": {
- "$ref": "#/definitions/Bounding_box"
- },
- "country": {
- "type": "string"
- },
- "country_code": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "place_type": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "Bounding_box": {
- "type": "object",
- "properties": {
- "coordinates": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "number"
- }
- }
- },
- "type": {
- "type": "string"
- }
- }
- },
- "Lists": {
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string"
- },
- "slug": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "following": {
- "type": "boolean"
- },
- "user": {
- "$ref": "#/definitions/Users"
- },
- "member_count": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "subscriber_count": {
- "type": "integer"
- },
- "id": {
- "type": "integer"
- },
- "uri": {
- "type": "string"
- }
- }
- },
- "Cursor_lists": {
- "type": "object",
- "properties": {
- "previous_cursor": {
- "type": "integer"
- },
- "lists": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Lists"
- }
- },
- "previous_cursor_str": {
- "type": "string"
- },
- "next_cursor": {
- "type": "integer"
- },
- "next_cursor_str": {
- "type": "string"
- }
- }
- },
- "Cursor_users": {
- "type": "object",
- "properties": {
- "previous_cursor": {
- "type": "integer"
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Users"
- }
- },
- "previous_cursor_str": {
- "type": "string"
- },
- "next_cursor": {
- "type": "integer"
- },
- "next_cursor_str": {
- "type": "string"
- }
- }
- },
- "Cursor_ids": {
- "type": "object",
- "properties": {
- "previous_cursor": {
- "type": "integer"
- },
- "users": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "previous_cursor_str": {
- "type": "string"
- },
- "next_cursor": {
- "type": "integer"
- },
- "next_cursor_str": {
- "type": "string"
- }
- }
- },
- "Messages": {
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string"
- },
- "entities": {
- "$ref": "#/definitions/Entities"
- },
- "id": {
- "type": "integer"
- },
- "id_string": {
- "type": "string"
- },
- "recipient": {
- "$ref": "#/definitions/Users"
- },
- "recipient_id": {
- "type": "integer"
- },
- "recipient_screen_name": {
- "type": "string"
- },
- "sender": {
- "$ref": "#/definitions/Users"
- },
- "sender_id": {
- "type": "integer"
- },
- "sender_screen_name": {
- "type": "string"
- },
- "text": {
- "type": "string"
- }
- }
- },
- "Query": {
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "id_str": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "position": {
- "type": "string"
- },
- "query": {
- "type": "string"
- }
- }
- },
- "Friendship": {
- "type": "object",
- "properties": {
- "relationship": {
- "$ref": "#/definitions/Targets"
- },
- "source": {
- "$ref": "#/definitions/Source"
- }
- }
- },
- "Targets": {
- "type": "object",
- "properties": {
- "target": {
- "$ref": "#/definitions/Target"
- }
- }
- },
- "Target": {
- "type": "object",
- "properties": {
- "id_str": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "followed_by": {
- "type": "boolean"
- },
- "screen_name": {
- "type": "string"
- },
- "following": {
- "type": "boolean"
- }
- }
- },
- "Source": {
- "type": "object",
- "properties": {
- "can_dm": {
- "type": "boolean"
- },
- "blocking": {
- "type": "boolean"
- },
- "id_str": {
- "type": "boolean"
- },
- "all_replies": {
- "type": "boolean"
- },
- "want_retweets": {
- "type": "boolean"
- },
- "id": {
- "type": "integer"
- },
- "marked_spam": {
- "type": "boolean"
- },
- "followed_by": {
- "type": "boolean"
- },
- "notifications_enable": {
- "type": "boolean"
- },
- "screen_name": {
- "type": "string"
- },
- "following": {
- "type": "boolean"
- }
- }
- },
- "Settings": {
- "type": "object",
- "properties": {
- "sleep_time": {
- "$ref": "#/definitions/Sleep"
- },
- "use_cookie_personalization": {
- "type": "boolean"
- },
- "trend_location": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Location"
- }
- },
- "language": {
- "type": "string"
- },
- "discoverable_by_email": {
- "type": "boolean"
- },
- "always_use_https": {
- "type": "boolean"
- },
- "protected": {
- "type": "boolean"
- },
- "geo_enabled": {
- "type": "boolean"
- },
- "show_all_inline_media": {
- "type": "boolean"
- },
- "screen_name": {
- "type": "string"
- }
- }
- },
- "Sleep": {
- "type": "object",
- "properties": {
- "end_time": {
- "type": "string"
- },
- "enabled": {
- "type": "boolean"
- },
- "start_time": {
- "type": "string"
- }
- }
- },
- "Location": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "placeType": {
- "$ref": "#/definitions/PlaceType"
- },
- "woeid": {
- "type": "integer"
- },
- "country": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "countryCode": {
- "type": "string"
- },
- "parentid": {
- "type": "integer"
- }
- }
- },
- "PlaceType": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "code": {
- "type": "integer"
- }
- }
- },
- "TrendInfo": {
- "type": "object",
- "properties": {
- "as_of": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "locations": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Location"
- }
- },
- "trends": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Trends"
- }
- }
- }
- },
- "Trends": {
- "type": "object",
- "properties": {
- "events": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "promoted_content": {
- "type": "string"
- },
- "query": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "Help_Config": {
- "type": "object",
- "properties": {
- "dm_text_character_limit": {
- "type": "integer"
- },
- "characters_reserved_per_media": {
- "type": "integer"
- },
- "max_media_per_upload": {
- "type": "integer"
- },
- "non_username_paths": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "photo_size_limit": {
- "type": "integer"
- },
- "photo_sizes": {
- "$ref": "#/definitions/Sizes"
- }
- }
- },
- "Help_Language": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- }
- },
- "Help_Privacy": {
- "type": "object",
- "properties": {
- "privacy": {
- "type": "string"
- }
- }
- },
- "Help_Tos": {
- "type": "object",
- "properties": {
- "Tos": {
- "type": "string"
- }
- }
- }
- }
- }
|