{"mock":"https://private-anon-06fa0a794b-trendaibackend.apiary-mock.com/v1/","production":"https://trendai-bb810.appspot.com/v1/","proxy":"https://private-anon-06fa0a794b-trendaibackend.apiary-proxy.com/v1/"}

FORMAT: 1A HOST: https://trendai-bb810.appspot.com/v1/ # TrendAi Backend API APIs document for TrendAi application. Almost requests are `JSON` and will be responded `JSON`, too. # Group Request ## General request Almost APIs requires a request with `application/json` content type (except API for upload file, image). # Group Response ## General response Almost APIs will responds with `application/json` content type. So, you can using any `Json parser` to handler our response. > In some cases, we will respond with `Empty body` using HTTP CODE `204`. ## Error response We can detect an request is error or not by using their `HTTP CODE`. Request with `non-2xx` http code is an error. With an error request, we will respond with `application/json` content type. See following format: ```json { "code": "unauthorized", "message": "Unauthorized" } ``` ### Common errors<a name="common-errors"></a> We must catch common errors in all API to ensure our application works properly. | HTTP CODE | Error code | Error message | |---|---|---| | 401 | `unauthorized` | Unauthorized access to this resource | | 403 | `inactivated` | Your account is not active | | 403 | `forbidden` | You need upgrade to premium account before access this resource | # Group Authentication TrendAi API use JWT to authenticate user. Exactly we used `JWT Bearer Authentication`. Almost APIs requires authentication on header with `Authorization` tag and value formatted: ```text Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRw319.sSaOosOuPWvTYVL ``` > If authentication fails, the system will respond with HTTP CODE `401`. See more about [Common errors](#common-errors) ## Login [POST /auth/login] Use this API for authentication. + Request (application/json) { "access_token": "6212189571-wzBJbsjkqASHSDm0MWcyAytGcsaJiK1XsKoeYcR", "access_token_secret": "NeSZj2xvwEJgUTOAmqNPln5jALE5hv12xvXF2KRhXb12" } + Response 200 (application/json) { "user": { "id": "5c9ad255ceddb700010693d1", "name": "deepsocial.ai", "email": "info@deepsocial.ai", "gender": "female", "dob": "1976-04-12T00:00:00Z", "education": "University", "avatar_url": "https://i.imgur.com/fXeY9zw.jpg", "location": { "address": "Phuong Mai, Ha Noi", "lat": 21.0276359, "lng": 105.83945 }, "interest_categories": [ { "id": "5c9b2f32ceddb700010694e7", "name": "Business & Finance", "slug": "news/business-and-finance" }, { "id": "5c9b2f32ceddb700010694ef", "name": "Travel", "slug": "lifestyle/travel" }, { "id": "5c9b2f33ceddb700010694f3", "name": "Lifestyle Personalities", "slug": "lifestyle/lifestyle-personalities" } ], "favourites_count": 18, "followers_count": 75, "friends_count": 370, "statuses_count": 66, "tweet_stat": { "reply_count": 0, "retweet_count": 3, "favorite_count": 2 }, "subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"], "created_at": "2019-03-27T01:31:01.75Z" }, "token": { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl...kMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJy...In0.5oa0dc5JnaGz_0lzK5fbDJpPDMrxGOh15YdW7JNu2SU" } } + Response 401 (application/json) { "code": "unauthorized", "message": "Unauthorized" } + Response 400 (application/json) { "code": "unauthorized", "message": "Couldn't parse your request" } # Group Users ## User information [/user] ### Get user information [GET] In order to authenticate a user, please add this header ``Authorization: Bearer {access_token}`` to your request. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) { "user": { "id": "5c9ad255ceddb700010693d1", "name": "deepsocial.ai", "email": "info@deepsocial.ai", "gender": "female", "dob": "1976-04-12T00:00:00Z", "education": "University", "avatar_url": "https://i.imgur.com/fXeY9zw.jpg", "location": { "address": "Phuong Mai, Ha Noi", "lat": 21.0276359, "lng": 105.83945 }, "interest_categories": [ { "id": "5c9b2f32ceddb700010694e7", "name": "Business & Finance", "slug": "news/business-and-finance" }, { "id": "5c9b2f32ceddb700010694ef", "name": "Travel", "slug": "lifestyle/travel" }, { "id": "5c9b2f33ceddb700010694f3", "name": "Lifestyle Personalities", "slug": "lifestyle/lifestyle-personalities" } ], "favourites_count": 18, "followers_count": 75, "friends_count": 370, "statuses_count": 66, "tweet_stat": { "reply_count": 0, "retweet_count": 3, "favorite_count": 2 }, "subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"], "created_at": "2019-03-27T01:31:01.75Z" }, "token": { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl...kMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJy...In0.5oa0dc5JnaGz_0lzK5fbDJpPDMrxGOh15YdW7JNu2SU" } } + Response 401 (application/json) { "code": "unauthorized", "message": "Unauthorized" } ### Update user information [PATCH /user] Update information for current user. All fields are optional. #### Fields available | Field | Description | Type | Require | Accept data | |---|---|---|---|---| | `name` | User's name | `string` | `no` | | | `gender` | User's gender | `string` | `no` | `male` `female` | | `dob` | User's date of bird | `string` | `no` | `YYYY-MM-DDTH:i:sZ` | | `education` | User's education | `string` | `no` | | | `location` | User's address | [`Location`](#location-object) | `no` | `Coordinates` `WOEID` | | `interest_categories` | User's interest categories | `[]string` | `no` | | #### Location object | Field | Description | Type | |---|---|---| | `address` | Location's address | `string` | | `lat` | Location's latitude coordinate | `float64` | | `lng` | Location's longitude coordinate | `float64` | | `woeid` | Where On Earth Identifier | `integer` | > Note: Location accept either Coordinates or WOEID. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Body { "name": "Bui Thang", "gender": "male", "dob": "1994-05-11T00:00:00Z", "education": "University", "location": { "address": "Phuong Mai, Ha Noi", "lat": 21.0276359, "lng": 105.83945 }, "interest_categories": ["5c7bd24195d42205ad86b4f7", "5c7bd24195d42205ad86b503"] } + Response 200 (application/json) { "user": { "id": "5c9ad255ceddb700010693d1", "name": "Bui Thang", "email": "info@deepsocial.ai", "gender": "male", "dob": "1994-05-11T00:00:00Z", "education": "University", "avatar_url": "https://i.imgur.com/fXeY9zw.jpg", "location": { "address": "Phuong Mai, Ha Noi", "lat": 21.0276359, "lng": 105.83945 }, "interest_categories": [ { "id": "5c7bd24195d42205ad86b4f7", "name": "Business & Finance", "slug": "news/business-and-finance" }, { "id": "5c7bd24195d42205ad86b503", "name": "Travel", "slug": "lifestyle/travel" } ], "favourites_count": 18, "followers_count": 75, "friends_count": 370, "statuses_count": 66, "tweet_stat": { "reply_count": 0, "retweet_count": 3, "favorite_count": 2 }, "subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"], "created_at": "2019-03-27T01:31:01.75Z" }, "token": { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl...kMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJy...In0.5oa0dc5JnaGz_0lzK5fbDJpPDMrxGOh15YdW7JNu2SU" } } + Response 400 (application/json) { "code": "request_invalid", "message": "Couldn't parse your request" } + Response 401 (application/json) { "code": "unauthorized", "message": "Unauthorized" } + Response 400 (application/json) { "code": "category_not_found", "message": "Categories doesn't exists" } + Response 500 (application/json) { "code": "update_failed", "message": "Couldn't update user" } ## Categories available [/user/categories] ### Get categories available [GET] Get list of categories available. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "id": "5c7bd24195d42205ad86b4f5", "name": "News", "slug": "news", "child": [ { "id": "5c7bd24195d42205ad86b4f6", "name": "Weather", "slug": "news/weather" }, { "id": "5c7bd24195d42205ad86b4f7", "name": "History", "slug": "news/history" }, { "id": "5c7bd24195d42205ad86b4f8", "name": "Politics", "slug": "news/politics" }, { "id": "5c7bd24195d42205ad86b4f9", "name": "Health", "slug": "news/health" } ] }, { "id": "5c7bd24195d42205ad86b500", "name": "Lifestyle", "slug": "lifestyle", "child": [ { "id": "5c7bd24195d42205ad86b501", "name": "Parenting", "slug": "lifestyle/parenting" }, { "id": "5c7bd24195d42205ad86b502", "name": "DIY & Home", "slug": "lifestyle/diy-and-home" } ] } ] + Response 500 (application/json) { "code": "get_failed", "message": "Couldn't get list categories" } ## Verify subscription [/user/subscription/verify] ### Verify subscription [POST] Verify the correctness of the subscription. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Body { "receipt_data": "MIInbQYJKoZIhvcNAQcCoIInXjCCJ1oCAQExCz...nTfC0Qsd2iiNLidvd8Q53l44=" } + Response 200 (application/json) [ { "source": "ios", "subscription_id": "TrendAI.RemoveAds", "transaction_id": "1000000516339612", "is_trial_period": false, "is_intro_period": false, "purchased_at": "2019-04-04T15:14:39Z" }, { "source": "ios", "subscription_id": "TrendAI.EverySixMonth", "transaction_id": "1000000516898206", "is_trial_period": false, "is_intro_period": false, "purchased_at": "2019-04-07T15:12:09Z", "expired_at": "2019-04-07T15:42:09Z" } ] + Response 400 (application/json) { "code": "missing_receipt", "message": "Missing receipt data." } + Response 400 (application/json) { "code": "verify_failed", "message": "Couldn't verify your receipt." } ## Get subscription status [/user/subscription/status{?id}] ### Get subscription status [GET] Get subscription's status and it's data. > List of `status` available: `subscribed` `not_subscribed`. + Parameters + id (required, string) - Subscription's ID + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) { "status": "subscribed", "subscription": { "source": "ios", "subscription_id": "TrendAI.EverySixMonth", "transaction_id": "1000000516904931", "is_trial_period": false, "is_intro_period": false, "purchased_at": "2019-04-07T17:37:30Z", "expired_at": "2019-04-07T17:40:30Z" } } + Response 400 (application/json) { "code": "missing_id", "message": "Missing subscription ID." } ## Deactivate [/user/deactivate] ### Deactivate account [POST] Deactivate current account. See more about [Common errors](#common-errors) to detect user is active or not. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 204 (application/json) + Response 500 (application/json) { "code": "save_failed", "message": "Couldn't update user data." } ## Group Trends ### Get trending topics by location [GET /trends/location{?lat,lng,woeid}] Get list of trending topics by location. > Note: `woeid` will be prioritized if it present in request. + Parameters + lat (optional, float) - Location's latitude + lng (optional, float) - Location's longitude + woeid (optional, number) - Woe location ID + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "id": "5c867826f4e15b63d1954e59", "name": "Seungri", "volume": 564238 }, { "id": "5c867826f4e15b63d1954e5a", "name": "#EpikHighxSUGA", "volume": 108667 }, { "id": "5c867826f4e15b63d1954e5b", "name": "#PerthFMTinVietNam", "volume": 46406 }, { "id": "5c867826f4e15b63d1954e5c", "name": "Jimin", "volume": 1253731 }, { "id": "5c867826f4e15b63d1954e5d", "name": "#2wish", "volume": 51056 } ] + Response 400 (application/json) { "code": "get_failed", "message": "Couldn't get trending data." } + Response 500 (application/json) { "code": "get_failed", "message": "Couldn't get trending data." } ### Get trending influencers by location [GET /trends/influencers/location{?topic_id}] Get list of trending influencers by topic which available on users' local. + Parameters + topic_id (required, string) - Trending topic ID which available on user's local. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "id": "5c972c066993582c76c882e3", "twitter_id": 83465789, "name": "Maria Lucia Martin", "screen_name": "Kitri1", "profile_image_url": "https://pbs.twimg.com/profile_images/3250494841/c967d68e0204f4a879b74bee59c68e60_normal.jpeg", "statuses_count": 506068, "followers_count": 4370, "friends_count": 4689, "reply_count": 0, "retweet_count": 0, "like_count": 0, "influencer_score": 102524.6 }, { "id": "5c972c066993582c76c882b8", "twitter_id": 1704550302, "name": "InteliGov", "screen_name": "inteligovbr", "profile_image_url": "https://pbs.twimg.com/profile_images/927661152326254597/pfOhqQDD_normal.jpg", "statuses_count": 181951, "followers_count": 1644, "friends_count": 2478, "reply_count": 0, "retweet_count": 0, "like_count": 0, "influencer_score": 36883.547 }, { "id": "5c972c066993582c76c882d5", "twitter_id": 133435134, "name": "UOL Política", "screen_name": "UOLPolitica", "profile_image_url": "https://pbs.twimg.com/profile_images/463786178869620736/zqToXzHK_normal.png", "statuses_count": 51656, "followers_count": 65519, "friends_count": 51, "reply_count": 0, "retweet_count": 0, "like_count": 442, "influencer_score": 30058.402 } ] + Response 400 (application/json) { "code": "topic_not_found", "message": "Topic doesn't exists." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't fetch influencers by trending topic." } ### Get trending contents by location [GET /trends/contents/location{?topic_id}{?sort}] Get list of trending contents by topic which available on users' local. + Parameters + topic_id (required, string) - Trending topic ID which available on user's local. + sort (required, string) - Sort type. Accepted values `top` `latest`, default is `latest`. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "user": { "id": "5c9733c4699358397c70283d", "twitter_id": 2455170542, "name": "NeiSilva", "screen_name": "neirao_games", "profile_image_url": "https://pbs.twimg.com/profile_images/457927094136107008/t1ZzqysY_normal.png" }, "id": "5c9733c4699358397c70283c", "twitter_id": 1109720062917836800, "twitter_user_id": 2455170542, "text": "RT @leandroruschel: Boa resposta de Bolsonaro a Rodrigo Maia: \"“Eu lamento. Até perdoo o Rodrigo Maia pela situação pessoal que ele está vi…", "lang": "pt", "entities": { "hashtags": [], "media": [], "urls": [], "user_mentions": [ { "indices": [ 3, 18 ], "twitter_id": 174818242, "name": "Leandro Ruschel 🗣", "screen_name": "leandroruschel" } ] }, "favorite_count": 0, "quote_count": 0, "reply_count": 0, "retweet_count": 2864, "content_score": 859.2, "media_score": 859.2, "created_at": "2019-03-24T07:34:15Z" }, { "user": { "id": "5c9733c4699358397c70281f", "twitter_id": 1651718538, "name": "Alberto", "screen_name": "betinhoamado", "profile_image_url": "https://pbs.twimg.com/profile_images/671114284684980225/Cve11Vgc_normal.jpg" }, "id": "5c9733c4699358397c70281e", "twitter_id": 1109720584571797505, "twitter_user_id": 1651718538, "text": "RT @MarcosCintra: O deputado Rodrigo Maia afirma que o governo é um “deserto de ideias”. Não aceito esta imputação. O Ministério da Economi…", "lang": "pt", "entities": { "hashtags": [], "media": [], "urls": [], "user_mentions": [ { "indices": [ 3, 16 ], "twitter_id": 25887356, "name": "Marcos Cintra", "screen_name": "MarcosCintra" } ] }, "favorite_count": 0, "quote_count": 0, "reply_count": 0, "retweet_count": 2829, "content_score": 848.7, "media_score": 848.7, "created_at": "2019-03-24T07:36:19Z" }, { "user": { "id": "5c9733c4699358397c702879", "twitter_id": 515146346, "name": "Gllauber Marlon", "screen_name": "gllaubermarlon", "profile_image_url": "https://pbs.twimg.com/profile_images/1057380213703761922/z8UdVksC_normal.jpg" }, "id": "5c9733c4699358397c70288d", "twitter_id": 1109718863653072897, "twitter_user_id": 515146346, "text": "RT @leandroruschel: Os políticos corruptos conseguiram emplacar a narrativa que o projeto anticrime de Moro atrapalha a reforma da previdên…", "lang": "pt", "entities": { "hashtags": [], "media": [], "urls": [], "user_mentions": [ { "indices": [ 3, 18 ], "twitter_id": 174818242, "name": "Leandro Ruschel 🗣", "screen_name": "leandroruschel" } ] }, "favorite_count": 0, "quote_count": 0, "reply_count": 0, "retweet_count": 2501, "content_score": 750.30005, "media_score": 750.30005, "created_at": "2019-03-24T07:29:29Z" } ] + Response 400 (application/json) { "code": "topic_not_found", "message": "Topic doesn't exists." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't get tweets by trending topic." } ### Get trending medias by location [GET /trends/medias/location{?topic_id}{?filter}{?sort}] Get list of trending medias by topic which available on users' local. + Parameters + topic_id (required, string) - Trending topic ID which available on user's local. + filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`. + sort (required, string) - Sort type. Accepted values `top` `latest`, default is `latest`. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "user": { "twitter_id": 50084102, "name": "Captain Disillusion", "screen_name": "CDisillusion", "profile_image_url": "https://pbs.twimg.com/profile_images/340150061/cd_twitter2_normal.jpg" }, "twitter_id": 1113482081789775872, "twitter_user_id": 50084102, "text": "Has it really been 2 years since I crossed that road in a Joker state of mind? https://t.co/0SP10h7lEs", "lang": "en", "entities": { "hashtags": [], "media": [ { "indices": [ 79, 102 ], "display_url": "pic.twitter.com/0SP10h7lEs", "expanded_url": "https://twitter.com/CDisillusion/status/1113482081789775872/video/1", "url": "https://t.co/0SP10h7lEs", "twitter_id": 1113481881469767681, "media_url": "http://pbs.twimg.com/ext_tw_video_thumb/1113481881469767681/pu/img/tVwOaMrv54-Gug4J.jpg", "media_url_https": "https://pbs.twimg.com/ext_tw_video_thumb/1113481881469767681/pu/img/tVwOaMrv54-Gug4J.jpg", "source_status_id": 0, "type": "video", "sizes": { "thumb": { "w": 150, "h": 150, "resize": "crop" }, "large": { "w": 1280, "h": 720, "resize": "fit" }, "medium": { "w": 1200, "h": 675, "resize": "fit" }, "small": { "w": 680, "h": 383, "resize": "fit" } }, "video_info": { "aspect_ratio": [ 16, 9 ], "duration_millis": 27402, "variants": [ { "content_type": "video/mp4", "bitrate": 2176000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/1280x720/crDatHkeuKeOzDeT.mp4?tag=8" }, { "content_type": "application/x-mpegURL", "bitrate": 0, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/pl/9Thpug2StFIUu8Lb.m3u8?tag=8" }, { "content_type": "video/mp4", "bitrate": 256000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/320x180/FLS-dVy7kzyZxDPt.mp4?tag=8" }, { "content_type": "video/mp4", "bitrate": 832000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/640x360/-c1kLOY_aclU8vTg.mp4?tag=8" } ] } } ], "urls": [], "user_mentions": [] }, "favorite_count": 229, "quote_count": 0, "reply_count": 0, "retweet_count": 22, "content_score": 52.4, "media_score": 52.4, "created_at": "2019-04-03T16:43:10Z" }, { "user": { "twitter_id": 1618180562, "name": "c", "screen_name": "chuuzus", "profile_image_url": "https://pbs.twimg.com/profile_images/1101016565980585985/LYI728yH_normal.jpg" }, "twitter_id": 1113482395557220352, "twitter_user_id": 1618180562, "text": "Heath Ledger as Joker was one of the best roles ever played by an actor. Heath did this role justice. https://t.co/jTxBPFB2yc", "lang": "en", "entities": { "hashtags": [], "media": [ { "indices": [ 102, 125 ], "display_url": "pic.twitter.com/jTxBPFB2yc", "expanded_url": "https://twitter.com/chuuzus/status/1113482395557220352/video/1", "url": "https://t.co/jTxBPFB2yc", "twitter_id": 1113479828571860995, "media_url": "http://pbs.twimg.com/amplify_video_thumb/1113479828571860995/img/anUHYleVESkjbQYD.jpg", "media_url_https": "https://pbs.twimg.com/amplify_video_thumb/1113479828571860995/img/anUHYleVESkjbQYD.jpg", "source_status_id": 0, "type": "video", "sizes": { "thumb": { "w": 150, "h": 150, "resize": "crop" }, "large": { "w": 1152, "h": 480, "resize": "fit" }, "medium": { "w": 1152, "h": 480, "resize": "fit" }, "small": { "w": 680, "h": 283, "resize": "fit" } }, "video_info": { "aspect_ratio": [ 12, 5 ], "duration_millis": 136831, "variants": [ { "content_type": "video/mp4", "bitrate": 2176000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/1152x480/OI5X_r61AWMexXc6.mp4?tag=11" }, { "content_type": "application/x-mpegURL", "bitrate": 0, "url": "https://video.twimg.com/amplify_video/1113479828571860995/pl/zIho7PGCyTqkAO2I.m3u8?tag=11" }, { "content_type": "video/mp4", "bitrate": 832000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/864x360/NXFWQhJLHY9n3b7C.mp4?tag=11" }, { "content_type": "video/mp4", "bitrate": 288000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/432x180/0xXFHxxNWcJ1RMKF.mp4?tag=11" } ] } } ], "urls": [], "user_mentions": [] }, "favorite_count": 106, "quote_count": 0, "reply_count": 0, "retweet_count": 34, "content_score": 31.400002, "media_score": 31.400002, "created_at": "2019-04-03T16:44:25Z" } ] + Response 400 (application/json) { "code": "topic_not_found", "message": "Topic doesn't exists." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't get tweets by trending topic." } ### Get trending topics by interest [GET /trends/interest{?category_id}] Get list of trending topics by interest category. + Parameters + category_id (required, string) - Interest category ID + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "id": "5c92f2cf6993580a396965f0", "name": "cheers", "volume": 100 }, { "id": "5c92f2cf6993580a396965f1", "name": "beer", "volume": 97 }, { "id": "5c92f2cf6993580a396965f2", "name": "pizza", "volume": 89 }, { "id": "5c92f2cf6993580a396965f3", "name": "games", "volume": 40 } ] + Response 400 (application/json) { "code": "category_not_found", "message": "Category doesn't exists." } + Response 400 (application/json) { "code": "category_not_interest", "message": "This isn't your interest category." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't fetch trending topics by interest category." } ### Get trending influencers by interest [GET /trends/influencers/interest{?category_id}] Get list of trending influencers by interest category. + Parameters + category_id (required, string) - Interest category ID + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "id": "5c943e7669935839ab307ce8", "twitter_id": 49800332, "name": "Matt Murphy", "screen_name": "MattMurph24", "profile_image_url": "https://pbs.twimg.com/profile_images/1106250842825465857/Lx23gZ6r_normal.jpg", "statuses_count": 930767, "followers_count": 30606, "friends_count": 17545, "reply_count": 0, "retweet_count": 0, "like_count": 384, "influencer_score": 195396.56 }, { "id": "5c943e7669935839ab307cc1", "twitter_id": 1596829382, "name": "Zyite", "screen_name": "ZyiteGadgets", "profile_image_url": "https://pbs.twimg.com/profile_images/487701633489313793/pIxJHFt5_normal.jpeg", "statuses_count": 912849, "followers_count": 3064, "friends_count": 4723, "reply_count": 0, "retweet_count": 0, "like_count": 0, "influencer_score": 183489 }, { "id": "5c943e7669935839ab307cac", "twitter_id": 1566650000, "name": "Raj 🦅 #VoteDem 🗽 Balasubramanian", "screen_name": "Solutioneer72", "profile_image_url": "https://pbs.twimg.com/profile_images/1081285881070264321/7eUlJvTB_normal.jpg", "statuses_count": 805949, "followers_count": 9613, "friends_count": 6907, "reply_count": 0, "retweet_count": 0, "like_count": 4, "influencer_score": 164074.4 } ] + Response 400 (application/json) { "code": "category_not_found", "message": "Category doesn't exists." } + Response 400 (application/json) { "code": "category_not_interest", "message": "This isn't your interest category." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't fetch influencers by category." } ### Get trending contents by interest [GET /trends/contents/interest{?category_id}{?sort}] Get list of trending contents by interest category. + Parameters + category_id (required, string) - Interest category ID + sort (required, string) - Sort type. Accepted values `top` `latest`, default is `latest`. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "user": { "id": "5c96f47c699358014828df2e", "twitter_id": 20261599, "name": "Mary OZ", "screen_name": "txMary", "profile_image_url": "https://pbs.twimg.com/profile_images/797696580199518208/q-lm6GiM_normal.jpg" }, "id": "5c96f47c699358014828df2d", "twitter_id": 1109652537295151104, "twitter_user_id": 20261599, "text": "RT @nbcsandiego: U.S. Customs and Border Protection officials are defending the decision to detain a 9-year-old girl who officers said prov…", "lang": "en", "entities": { "hashtags": [], "media": [], "urls": [], "user_mentions": [ { "indices": [ 3, 15 ], "twitter_id": 15535860, "name": "#NBC7 San Diego", "screen_name": "nbcsandiego" } ] }, "favorite_count": 0, "quote_count": 0, "reply_count": 0, "retweet_count": 6439, "content_score": 1931.7001, "media_score": 1931.7001, "created_at": "2019-03-24T03:05:55Z" }, { "user": { "id": "5c96f47c699358014828ded2", "twitter_id": 16459239, "name": "TORT", "screen_name": "MTort41", "profile_image_url": "https://pbs.twimg.com/profile_images/1108941793427521539/8vUnNdXs_normal.jpg" }, "id": "5c96f47c699358014828ded1", "twitter_id": 1109652831185915904, "twitter_user_id": 16459239, "text": "RT @KimDotcom: Mueller - The name that ended all mainstream media credibility.\n\nNo matter what you think of Donald Trump. His unexpected ri…", "lang": "en", "entities": { "hashtags": [], "media": [], "urls": [], "user_mentions": [ { "indices": [ 3, 13 ], "twitter_id": 611986351, "name": "Kim Dotcom", "screen_name": "KimDotcom" } ] }, "favorite_count": 0, "quote_count": 0, "reply_count": 0, "retweet_count": 2020, "content_score": 606, "media_score": 606, "created_at": "2019-03-24T03:07:05Z" } ] + Response 400 (application/json) { "code": "category_not_found", "message": "Category doesn't exists." } + Response 400 (application/json) { "code": "category_not_interest", "message": "This isn't your interest category." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't get tweets by category." } ### Get trending medias by interest [GET /trends/medias/interest{?category_id}{?filter}{?sort}] Get list of trending medias by interest category. + Parameters + category_id (required, string) - Interest category ID + filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`. + sort (required, string) - Sort type. Accepted values `top` `latest`, default is `latest`. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "user": { "twitter_id": 50084102, "name": "Captain Disillusion", "screen_name": "CDisillusion", "profile_image_url": "https://pbs.twimg.com/profile_images/340150061/cd_twitter2_normal.jpg" }, "twitter_id": 1113482081789775872, "twitter_user_id": 50084102, "text": "Has it really been 2 years since I crossed that road in a Joker state of mind? https://t.co/0SP10h7lEs", "lang": "en", "entities": { "hashtags": [], "media": [ { "indices": [ 79, 102 ], "display_url": "pic.twitter.com/0SP10h7lEs", "expanded_url": "https://twitter.com/CDisillusion/status/1113482081789775872/video/1", "url": "https://t.co/0SP10h7lEs", "twitter_id": 1113481881469767681, "media_url": "http://pbs.twimg.com/ext_tw_video_thumb/1113481881469767681/pu/img/tVwOaMrv54-Gug4J.jpg", "media_url_https": "https://pbs.twimg.com/ext_tw_video_thumb/1113481881469767681/pu/img/tVwOaMrv54-Gug4J.jpg", "source_status_id": 0, "type": "video", "sizes": { "thumb": { "w": 150, "h": 150, "resize": "crop" }, "large": { "w": 1280, "h": 720, "resize": "fit" }, "medium": { "w": 1200, "h": 675, "resize": "fit" }, "small": { "w": 680, "h": 383, "resize": "fit" } }, "video_info": { "aspect_ratio": [ 16, 9 ], "duration_millis": 27402, "variants": [ { "content_type": "video/mp4", "bitrate": 2176000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/1280x720/crDatHkeuKeOzDeT.mp4?tag=8" }, { "content_type": "application/x-mpegURL", "bitrate": 0, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/pl/9Thpug2StFIUu8Lb.m3u8?tag=8" }, { "content_type": "video/mp4", "bitrate": 256000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/320x180/FLS-dVy7kzyZxDPt.mp4?tag=8" }, { "content_type": "video/mp4", "bitrate": 832000, "url": "https://video.twimg.com/ext_tw_video/1113481881469767681/pu/vid/640x360/-c1kLOY_aclU8vTg.mp4?tag=8" } ] } } ], "urls": [], "user_mentions": [] }, "favorite_count": 229, "quote_count": 0, "reply_count": 0, "retweet_count": 22, "content_score": 52.4, "media_score": 52.4, "created_at": "2019-04-03T16:43:10Z" }, { "user": { "twitter_id": 1618180562, "name": "c", "screen_name": "chuuzus", "profile_image_url": "https://pbs.twimg.com/profile_images/1101016565980585985/LYI728yH_normal.jpg" }, "twitter_id": 1113482395557220352, "twitter_user_id": 1618180562, "text": "Heath Ledger as Joker was one of the best roles ever played by an actor. Heath did this role justice. https://t.co/jTxBPFB2yc", "lang": "en", "entities": { "hashtags": [], "media": [ { "indices": [ 102, 125 ], "display_url": "pic.twitter.com/jTxBPFB2yc", "expanded_url": "https://twitter.com/chuuzus/status/1113482395557220352/video/1", "url": "https://t.co/jTxBPFB2yc", "twitter_id": 1113479828571860995, "media_url": "http://pbs.twimg.com/amplify_video_thumb/1113479828571860995/img/anUHYleVESkjbQYD.jpg", "media_url_https": "https://pbs.twimg.com/amplify_video_thumb/1113479828571860995/img/anUHYleVESkjbQYD.jpg", "source_status_id": 0, "type": "video", "sizes": { "thumb": { "w": 150, "h": 150, "resize": "crop" }, "large": { "w": 1152, "h": 480, "resize": "fit" }, "medium": { "w": 1152, "h": 480, "resize": "fit" }, "small": { "w": 680, "h": 283, "resize": "fit" } }, "video_info": { "aspect_ratio": [ 12, 5 ], "duration_millis": 136831, "variants": [ { "content_type": "video/mp4", "bitrate": 2176000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/1152x480/OI5X_r61AWMexXc6.mp4?tag=11" }, { "content_type": "application/x-mpegURL", "bitrate": 0, "url": "https://video.twimg.com/amplify_video/1113479828571860995/pl/zIho7PGCyTqkAO2I.m3u8?tag=11" }, { "content_type": "video/mp4", "bitrate": 832000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/864x360/NXFWQhJLHY9n3b7C.mp4?tag=11" }, { "content_type": "video/mp4", "bitrate": 288000, "url": "https://video.twimg.com/amplify_video/1113479828571860995/vid/432x180/0xXFHxxNWcJ1RMKF.mp4?tag=11" } ] } } ], "urls": [], "user_mentions": [] }, "favorite_count": 106, "quote_count": 0, "reply_count": 0, "retweet_count": 34, "content_score": 31.400002, "media_score": 31.400002, "created_at": "2019-04-03T16:44:25Z" } ] + Response 400 (application/json) { "code": "category_not_found", "message": "Category doesn't exists." } + Response 400 (application/json) { "code": "category_not_interest", "message": "This isn't your interest category." } + Response 500 (application/json) { "code": "system_error", "message": "Couldn't get tweets by category." } ## Group Tweets ### Search tweets [GET /tweets{?topic_id}{?lat,lng,radius}] Get list of tweets by trending topic. + Parameters + topic_id (required, string) - Trending topic ID + lat (optional, number) - Geocode's latitude + lng (optional, number) - Geocode's longitude + radius (optional, string) - Geocode's radius. Accept unit `mil` (mile) and `km` (kilometer). Example: `10mil`, `100km`. + Request (application/json) + Headers Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug + Response 200 (application/json) [ { "user": { "id": "5c8b204ef0460002686c6b77", "twitter_id": 39344374, "name": "Donald Trump Jr.", "screen_name": "DonaldJTrumpJr", "profile_image_url": "https://pbs.twimg.com/profile_images/766652495858896897/LjrJJB9a_normal.jpg" }, "id": "5c8b204ef0460002686c6b78", "twitter_id": 1106177702204239872, "twitter_user_id": 39344374, "text": "Lisa Page: Strzok Hoped Mueller Probe Would Lead to Impeaching Trump to Advance his Own Career – Dan Bongino https://t.co/0ZvM6dG6jT", "lang": "en", "entities": { "hashtags": [], "media": [], "urls": [ { "indices": [ 109, 132 ], "display_url": "bongino.com/lisa-page-strz…", "expanded_url": "https://bongino.com/lisa-page-strzok-hoped-mueller-probe-would-lead-to-impeaching-trump-advance-his-own-career/", "url": "https://t.co/0ZvM6dG6jT" } ], "user_mentions": [] }, "favorite_count": 21187, "quote_count": 0, "reply_count": 0, "retweet_count": 8932, "created_at": "2019-03-14T12:58:10Z" }, { "user": { "id": "5c8b204ef0460002686c6b79", "twitter_id": 216881337, "name": "Senator Rand Paul", "screen_name": "RandPaul", "profile_image_url": "https://pbs.twimg.com/profile_images/681152691461042177/_PrgDgFA_normal.jpg" }, "id": "5c8b204ef0460002686c6b7a", "twitter_id": 1105887640879022080, "twitter_user_id": 216881337, "text": "This deserves more attention! FBI Mistress, Lisa Page, confirmed to House Judiciary, there was an anti-Trump Insurance Policy and it's the fake Russian investigation! She admits there was almost no evidence on collusion, yet they continued with WITCH HUNT! https://t.co/vCIikT4tyr", "lang": "en", "entities": { "hashtags": [], "media": [], "urls": [ { "indices": [ 257, 280 ], "display_url": "foxnews.com/politics/lisa-…", "expanded_url": "https://www.foxnews.com/politics/lisa-page-transcripts-reveal-details-of-anti-trump-insurance-policy-concerns-over-full-blown-probe", "url": "https://t.co/vCIikT4tyr" } ], "user_mentions": [] }, "favorite_count": 46267, "quote_count": 0, "reply_count": 0, "retweet_count": 22316, "created_at": "2019-03-13T17:45:34Z" } ] # Group Locations ## Locations [GET /locations/woe] Get all WOE locations available. + Request (application/json) + Response 200 (application/json) [ { "woeid": 23424740, "name": "Algeria", "country": "Algeria", "country_code": "DZ", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } }, { "woeid": 23424747, "name": "Argentina", "country": "Argentina", "country_code": "AR", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } }, { "woeid": 1252351, "name": "Can Tho", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 1252376, "name": "Da Nang", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 23424984, "name": "Vietnam", "country": "Vietnam", "country_code": "VN", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } } ] ## Countries [GET /locations/woe/countries] Get all countries available. + Request (application/json) + Response 200 (application/json) [ { "woeid": 23424740, "name": "Algeria", "country": "Algeria", "country_code": "DZ", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } }, { "woeid": 23424747, "name": "Argentina", "country": "Argentina", "country_code": "AR", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } }, { "woeid": 23424984, "name": "Vietnam", "country": "Vietnam", "country_code": "VN", "parent_id": 1, "place_type": { "code": 12, "name": "Country" } } ] + Response 500 (application/json) { "code": "get_failed", "message": "Couldn't get countries." } ## Towns [GET /locations/woe/towns{?country_code}] Get all towns in a country. + Parameters + country_code (required, string) - Country code + Request (application/json) + Response 200 (application/json) [ { "woeid": 1252351, "name": "Can Tho", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 1252376, "name": "Da Nang", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 1236690, "name": "Hai Phong", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 1236594, "name": "Hanoi", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } }, { "woeid": 1252431, "name": "Ho Chi Minh City", "country": "Vietnam", "country_code": "VN", "parent_id": 23424984, "place_type": { "code": 7, "name": "Town" } } ] + Response 400 (application/json) { "code": "missing_country_code", "message": "Missing country_code." } + Response 500 (application/json) { "code": "get_failed", "message": "Couldn't get towns." } # Group Static pages ## Terms of Services [GET /public/term.html] Terms of Services page was stored at path `/public/term.html` + Request (text/html) + Response 200 (text/html) ## Privacy Policy [GET /public/privacy.html] Privacy Policy page was stored at path `/public/privacy.html` + Request (text/html) + Response 200 (text/html)