{"mock":"https://private-anon-cbb2e903f3-trendaibackend.apiary-mock.com/v1/","production":"https://backend.trendai.app/v1/","proxy":"https://private-anon-cbb2e903f3-trendaibackend.apiary-proxy.com/v1/"}
FORMAT: 1A
HOST: https://backend.trendai.app/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 | `unverified` | Your account has not verified |
| 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)
## Authentication [POST /auth]
Account authentication by the provider's credentials.
##### List of supported providers
Currently, this API has supported the following providers:
- [Internal account registration](#1-internal-account-registration)
- [Internal account authentication](#2-internal-account-authentication)
##### 1. Internal account registration <a name="1-internal-account-registration"></a>
- Provider: `register`
- Example request packet:
{
"provider": "register",
"credentials": {
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"password": "123456789",
"password_confirmation": "123456789",
"gender": "male",
"education": "University",
"location": {
"address": "187 Giai Phong, Ha Noi",
"lat": 102.14756899901,
"lng": 18.91189231878
},
"dob": "1994-05-11T00:00:00Z"
}
}
##### 2. Internal account authentication <a name="2-internal-account-authentication"></a>
- Provider: `internal`
- Example request packet:
{
"provider": "internal",
"credentials": {
"email": "zenthangplus@gmail.com",
"password": "123456789"
}
}
View request example for more details.
+ Request (application/json)
{
"provider": "internal",
"credentials": {
"email": "zenthangplus@gmail.com",
"password": "123456789"
}
}
+ Response 200 (application/json)
{
"user": {
"id": "5cea2275d81e9112da43cd95",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "thangbui.hust@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"education": "",
"avatar_url": "",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
],
"favourites_count": 0,
"followers_count": 0,
"friends_count": 0,
"statuses_count": 0,
"influencer_score": 0,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"premium": false,
"created_at": "2019-05-26T05:21:57.3371097Z"
},
"token": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...J9.47gth34YXbmu3xtZ0s5KBbBJaAM3PylSWb2DNndwOM4",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...In0.RRHXkcvEjuvsD0v-5Y-95uQ9cBtJT-cySKkundQ0410"
}
}
+ Response 400 (application/json)
{
"code": "unauthorized",
"message": "Couldn't parse your request"
}
+ Response 403 (application/json)
{
"code": "unverified",
"message": "Your account has not verified"
}
## Resend verification [POST /auth/resend]
Resend verification code or activation link.
+ Request (application/json)
{
"email": "zenthangplus@gmail.com"
}
+ Response 204 (application/json)
+ Response 400 (application/json)
{
"code": "verified",
"message": "Your account has been verified"
}
## Password recovery [POST /auth/recover]
Password recovery API.
+ Request (application/json)
{
"email": "zenthangplus@gmail.com"
}
+ Response 204 (application/json)
+ Response 400 (application/json)
{
"code": "email_not_found",
"message": "Couldn't verify your email address"
}
# Group Users
## Get [/user]
### Get user [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": "5cea2275d81e9112da43cd95",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "thangbui.hust@gmail.com",
"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
},
"external_users": [
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
],
"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,
"influencer_score": 0,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 3,
"favorite_count": 2
},
"subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"],
"premium": true,
"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/]
### Update user's information [PATCH]
Update information for current user. All fields are optional.
#### Fields available
| Field | Description | Type | Require | Accept data |
|---|---|---|---|---|
| `first_name` | Full name | `string` | `no` | |
| `last_name` | Full name | `string` | `no` | |
| `email` | Email address | `string` | `no` | |
| `username` | Username | `string` | `no` | |
| `gender` | User's gender | `string` | `no` | `male` `female` `other` |
| `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` | 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 eyJ0iLIUzI1NiJ9.eyJcyJ9.qAuvOB4RmqLmEokv-05ttL8BzPRBAug
+ Body
{
"first_name": "Thang",
"last_name": "Bui",
"email": "zenthangplus@gmail.com",
"username": "zenthangplus",
"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",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"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
},
"external_users": [
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
],
"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,
"influencer_score": 0,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 3,
"favorite_count": 2
},
"subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"],
"premium": true,
"created_at": "2019-03-27T01:31:01.75Z"
},
"token": {
"access_token": "eyJhbGciOipXVCJ9.eyJlkMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw",
"refresh_token": "eyJhbGIkpXVCJ9.eyJyIn0.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"
}
## Upload Avatar [/user/avatar]
### Upload avatar [PATCH]
Update avatar for current user.
+ Request (multipart/form-data; boundary=---BOUNDARY)
+ Headers
Authorization: Bearer eyJ0iLIUzI1NiJ9.eyJcyJ9.qAuvOB4RmqLmEokv-05ttL8BzPRBAug
+ Body
-----BOUNDARY
Content-Disposition: form-data; name="avatar"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
+ Response 200 (application/json)
{
"user": {
"id": "5c9ad255ceddb700010693d1",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"education": "University",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5c9ad255ceddb700010693d1-yuvjfrjppplvxdqd.jpg",
"banner_url": "",
"location": {
"address": "Phuong Mai, Ha Noi",
"lat": 21.0276359,
"lng": 105.83945
},
"external_users": [
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
],
"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,
"influencer_score": 0,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 3,
"favorite_count": 2
},
"subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"],
"premium": true,
"created_at": "2019-03-27T01:31:01.75Z"
},
"token": {
"access_token": "eyJhbGciOipXVCJ9.eyJlkMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw",
"refresh_token": "eyJhbGIkpXVCJ9.eyJyIn0.5oa0dc5JnaGz_0lzK5fbDJpPDMrxGOh15YdW7JNu2SU"
}
}
+ Response 400 (application/json)
{
"code": "request_invalid",
"message": "Couldn't parse your request"
}
+ Response 401 (application/json)
{
"code": "unauthorized",
"message": "Unauthorized"
}
+ Response 500 (application/json)
{
"code": "system_error",
"message": "System error"
}
## Upload Banner [/user/banner]
### Upload banner [PATCH]
Update banner for current user.
+ Request (multipart/form-data; boundary=---BOUNDARY)
+ Headers
Authorization: Bearer eyJ0iLIUzI1NiJ9.eyJcyJ9.qAuvOB4RmqLmEokv-05ttL8BzPRBAug
+ Body
-----BOUNDARY
Content-Disposition: form-data; name="banner"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
+ Response 200 (application/json)
{
"user": {
"id": "5c9ad255ceddb700010693d1",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"education": "University",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5c9ad255ceddb700010693d1-yuvjfrjppplvxdqd.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/avatar/5c9ad255ceddb700010693d1-niyxcmmfgbpbtpjq.jpg",
"location": {
"address": "Phuong Mai, Ha Noi",
"lat": 21.0276359,
"lng": 105.83945
},
"external_users": [
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
],
"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,
"influencer_score": 0,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 3,
"favorite_count": 2
},
"subscriptions": ["trendAi.removeAds", "trendAi.oneWeek"],
"premium": true,
"created_at": "2019-03-27T01:31:01.75Z"
},
"token": {
"access_token": "eyJhbGciOipXVCJ9.eyJlkMSJ9.hyvgR2tzPVbpyvlXJ89tB0G5r3K881jpjaGs6oTvOHw",
"refresh_token": "eyJhbGIkpXVCJ9.eyJyIn0.5oa0dc5JnaGz_0lzK5fbDJpPDMrxGOh15YdW7JNu2SU"
}
}
+ Response 400 (application/json)
{
"code": "request_invalid",
"message": "Couldn't parse your request"
}
+ Response 401 (application/json)
{
"code": "unauthorized",
"message": "Unauthorized"
}
+ Response 500 (application/json)
{
"code": "system_error",
"message": "System error"
}
## Following [/user/followings]
### Get followings [GET]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXI1NiJ9.eyJcyJ9.qAuvOPCQqLmEokv-05ttL8BzPRBAug
+ Response 200 (application/json)
{
"posts": [
{
"id": "5e1f37271728f61eae233b38",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "Welcome to TrendAI!",
"reaction": {
"liked": false,
"like_count": 1,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:00:39.577Z"
}
],
"topics": [
{
"id": "5ddd3a8b4f037d11b3943d7f",
"name": "#AAA2019",
"volume": 532638
},
{
"id": "5ddd3a8b4f037d11b3943d9e",
"name": "#GOT7",
"volume": 514033
}
],
"updated_at": "2020-01-15T16:24:40.42732554Z"
}
### Follow a object [POST]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXI1NiJ9.eyJcyJ9.qAuvOPCQqLmEokv-05ttL8BzPRBAug
+ Body
{
"post_id": "5dc6dd2be46fdf0063995c75",
"topic_id": "5dc6dd2be46fdf0063995c76",
"topic_name": "Trump",
}
+ Response 200 (application/json)
{
"posts": [
{
"id": "5e1f37271728f61eae233b38",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "Welcome to TrendAI!",
"reaction": {
"liked": false,
"like_count": 1,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:00:39.577Z"
}
],
"topics": [
{
"id": "5ddd3a8b4f037d11b3943d7f",
"name": "#AAA2019",
"volume": 532638
},
{
"id": "5ddd3a8b4f037d11b3943d9e",
"name": "#GOT7",
"volume": 514033
}
],
"updated_at": "2020-01-15T16:24:40.42732554Z"
}
### Un-follow a object [DELETE]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXI1NiJ9.eyJcyJ9.qAuvOPCQqLmEokv-05ttL8BzPRBAug
+ Body
{
"post_id": "5dc6dd2be46fdf0063995c75",
"topic_id": "5dc6dd2be46fdf0063995c76",
}
+ Response 200 (application/json)
{
"posts": [
{
"id": "5e1f37271728f61eae233b38",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "Welcome to TrendAI!",
"reaction": {
"liked": false,
"like_count": 1,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:00:39.577Z"
}
],
"topics": [
{
"id": "5ddd3a8b4f037d11b3943d7f",
"name": "#AAA2019",
"volume": 532638
},
{
"id": "5ddd3a8b4f037d11b3943d9e",
"name": "#GOT7",
"volume": 514033
}
],
"updated_at": "2020-01-15T16:24:40.42732554Z"
}
## Password [/user/password]
### Change password [POST]
Change password for current user.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXI1NiJ9.eyJcyJ9.qAuvOPCQqLmEokv-05ttL8BzPRBAug
+ Body
{
"current_password": "123456",
"password": "123456789",
"password_confirmation": "123456789"
}
+ Response 204 (application/json)
+ Response 400 (application/json)
{
"code": "invalid_confirmation",
"message": "The password confirmation doesn't match"
}
## External account [/user/accounts]
### Get list of social accounts [GET]
Get all social accounts which are associated with current user.
+ Request (application/json)
+ Response 200 (application/json)
[
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
},
{
"source": "facebook",
"app_id": "1566331355",
"user_id": "3154446567671222",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
]
### Associate external account [POST]
By using this API, you can associates current account with another external account.
##### List of supported providers
Currently, this API has supported the following providers:
- [Twitter authentication](#1-twitter-authentication)
- [Facebook authentication](#2-facebook-authentication)
- [Instagram authentication](#3-instagram-authentication)
- [Google authentication](#4-google-authentication)
- [Taking over ownership](#5-taking-over-ownership)
##### 1. Twitter authentication <a name="1-twitter-authentication"></a>
- Provider: `twitter`
- Example request packet:
{
"provider": "twitter",
"credentials": {
"access_token": "1119074996513-uiIZcbb3U7GUq0DX3bzhzsK",
"access_token_secret": "rO3a7R7yLXPJEL0WfyyXsQ05M644KQBkYuK"
}
}
##### 2. Facebook authentication <a name="2-facebook-authentication"></a>
- Provider: `facebook`
- Example request packet:
{
"provider": "facebook",
"credentials": {
"access_token": "EAADGPk7OZCagBAFZCauWaLCUyRInm3ZCeBMiAUIcczFA1rJOpBKoXspcpYd01Iw2iAoeA"
}
}
> Note: In order to collect user data, please using this Facebook scopes:
> `email` `public_profile` `user_birthday` `user_gender` `user_location` `user_friends` `user_posts`.
##### 3. Instagram authentication <a name="3-instagram-authentication"></a>
- Provider: `instagram`
- Example request packet:
{
"provider": "instagram",
"credentials": {
"auth_code": "371871c3f14d41cfa1e7292f47592555"
}
}
##### 4. Google authentication <a name="4-google-authentication"></a>
- Provider: `google`
- Example request packet:
{
"provider": "google",
"credentials": {
"auth_code": "4/ZQE3D9Z8zlJt9U-I96jreNJnGyi-AH_IlFqBZ7dGr42yW6-qXBqfI"
}
}
##### 5. Taking over ownership <a name="5-taking-over-ownership"></a>
- Provider: `taking_over_ownership`
- Example request packet:
{
"provider": "taking_over_ownership",
"credentials": {
"token": "YNCUHOFKUQIJDBQBUFBVJAURQCNZATCM"
}
}
View request for more details.
+ Request (application/json)
{
"provider": "facebook",
"credentials": {
"access_token": "EAADGPk7OZCagBAFZCauWaLCUyRInm3ZCeBMiAUIcczFA1rJOpBKoXspcpYd01Iw2iAoeA"
}
}
+ Response 200 (application/json)
[
{
"source": "facebook",
"app_id": "896664107147253",
"user_id": "689268781493158",
"full_name": "Thang Bui",
"email": "thangbui@example.com",
"summary": {
"comments_count": 1,
"friends_count": 3,
"likes_count": 2,
"posts_count": 6,
"shares_count": 0
},
"last_connected_at": "2019-08-04T11:05:32.705Z",
"created_at": "2019-06-07T14:20:36.884Z"
},
{
"source": "instagram",
"app_id": "70f67afa7be84a3b9936915acda25f05",
"user_id": "1210956184",
"username": "thangbui",
"full_name": "Thang Bui",
"summary": {
"comments_count": 3,
"followers_count": 109,
"followings_count": 171,
"likes_count": 6,
"posts_count": 1
},
"last_connected_at": "2019-08-04T10:39:00.988Z",
"created_at": "2019-06-07T14:22:56.971Z"
},
{
"source": "twitter",
"app_id": "15926829",
"user_id": "973082059118804992",
"username": "thangbui",
"full_name": "Thang Bui",
"email": "thangbui@example.com",
"summary": {
"favourites_count": 20,
"followers_count": 80,
"followings_count": 372,
"statuses_count": 77,
"likes_count": 4,
"comments_count": 0,
"retweet_count": 51
},
"last_connected_at": "2019-08-04T11:18:39.3223326Z",
"created_at": "2019-08-04T11:06:50.353Z"
},
{
"source": "google",
"app_id": "595044430029-uma2hj3rstve92g54brbdjekgeubjs7j.apps.googleusercontent.com",
"user_id": "109688976368692019037",
"full_name": "Thang Bui",
"email": "thangbui@example.com",
"last_connected_at": "2019-06-10T17:16:47.008Z",
"created_at": "2019-06-10T17:16:47.008Z"
}
]
+ Response 400 (application/json)
{
"code": "associated_another",
"message": "Your twitter account has associated with another account",
"data": {
"taking_over_ownership_token": "YNCUHOFKUQIJDBQBUFBVJAURQCNZATCM",
"expired_at": "2019-07-20T16:16:59.714267256Z"
}
}
### Remove external accounts [DELETE]
Remove one or more external accounts from current account.
List of supported providers:
- `twitter`
- `facebook`
- `google`
- `instagram`
+ Request (application/json)
{
"providers": ["facebook", "google"]
}
+ Response 200 (application/json)
[
{
"source": "twitter",
"app_id": "15926829",
"user_id": "1119074959983296513",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"last_connected_at": "2019-06-04T09:47:10.464Z",
"created_at": "2019-05-09T08:41:05.121Z"
}
]
+ Response 400 (application/json)
{
"code": "invalid_provider",
"message": "One or more providers are invalid"
}
## Get subscription [/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."
}
## Verify subscription [/user/subscription/verify]
### Verify subscription [POST]
Verify the correctness of the subscription.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzcyJ9.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."
}
## Deactivate account [/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."
}
## Notification [/user/notification-tokens]
Notification payload:
```json
{
"event": "trending_post|new_comment|new_reaction",
"tweet_id": "the-tweet-id"
}
```
### Register a notification token [POST]
Supported device types: `android` `ios` `web`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Body
{
"device_type": "ios",
"device_token": "ABNBNQ-HJHQNA-QJKLQ-UUQHH"
}
+ Response 204 (application/json)
## Logout [/user/logout]
### Logout current session [POST]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Response 204 (application/json)
## 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"
}
## 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": "5e1f3e2b1728f6292ae28586",
"first_name": "Carla",
"last_name": "Angola TV",
"username": "reference_twitter_carlaangola",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1187033996317941760/lHm2aF5R_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 608,
"followers_count": 2524048,
"friends_count": 2340,
"statuses_count": 34600,
"influencer_score": 29.527605,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "72627916",
"reference_unique_id": "twitter.72627916"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
},
{
"id": "5e1f331a1728f61556163fe9",
"first_name": "Donald",
"last_name": "J. Trump",
"username": "reference_twitter_realDonaldTrump",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/874276197357596672/kUuht00m_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 6,
"followers_count": 70983414,
"friends_count": 47,
"statuses_count": 47878,
"influencer_score": 28.050983,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "25073877",
"reference_unique_id": "twitter.25073877"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
}
]
+ 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}{?query}{?lat,lng,radius}{?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.
+ query (optional, string) - Query for searching tweets.
+ lat (optional, number) - Location's latitude for searching tweets by location.
+ lng (optional, number) - Location's longitude for searching tweets by location.
+ radius (optional, number) - Radius for searching tweets by location. Accept unit `mil` (mile) and `km` (kilometer). Default `10km`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1de33d1728f600c7d0dbc8",
"user": {
"id": "5e1de4f01728f604b5726517",
"first_name": "BBC",
"last_name": "",
"username": "reference_twitter_BBC",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1110178686450483200/F5-Jmzk7_normal.png",
"metas": {
"reference_code": "twitter",
"reference_id": "19701628",
"reference_unique_id": "twitter.19701628"
}
},
"text": "A hot air balloon made of recycled plastic bags will fly from London to Seoul as part of an art project launched by @BTS_twt.\n#BTS #ARMY \n👉 https://t.co/etehCIRwNP https://t.co/5PjWBrR18Q",
"entities": {
"hashtags": [
{
"indices": [
126,
130
],
"text": "BTS"
},
{
"indices": [
131,
136
],
"text": "ARMY"
}
],
"urls": [
{
"indices": [
140,
163
],
"display_url": "bbc.in/2FMDqGj",
"expanded_url": "http://bbc.in/2FMDqGj",
"url": "https://t.co/etehCIRwNP"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EOQDghyW4AUlKCA.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"medium": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"small": {
"w": 680,
"h": 385,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 32195,
"comment_count": 0,
"share_count": 13298
},
"content_score": 22.923088,
"media_score": 22.923088,
"metas": {
"reference_code": "twitter",
"reference_id": "1217101659379314694",
"reference_user_id": "19701628"
},
"updated_at": "2020-01-15T16:31:50.846033237Z",
"created_at": "2020-01-14T15:10:22Z"
}
]
+ 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}{?query}{?lat,lng,radius}{?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.
+ query (optional, string) - Query for searching tweets.
+ lat (optional, number) - Location's latitude for searching tweets by location.
+ lng (optional, number) - Location's longitude for searching tweets by location.
+ radius (optional, number) - Radius for searching tweets by location. Accept unit `mil` (mile) and `km` (kilometer). Default `10km`.
+ filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1de33d1728f600c7d0dbc8",
"user": {
"id": "5e1de4f01728f604b5726517",
"first_name": "BBC",
"last_name": "",
"username": "reference_twitter_BBC",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1110178686450483200/F5-Jmzk7_normal.png",
"metas": {
"reference_code": "twitter",
"reference_id": "19701628",
"reference_unique_id": "twitter.19701628"
}
},
"text": "A hot air balloon made of recycled plastic bags will fly from London to Seoul as part of an art project launched by @BTS_twt.\n#BTS #ARMY \n👉 https://t.co/etehCIRwNP https://t.co/5PjWBrR18Q",
"entities": {
"hashtags": [
{
"indices": [
126,
130
],
"text": "BTS"
},
{
"indices": [
131,
136
],
"text": "ARMY"
}
],
"urls": [
{
"indices": [
140,
163
],
"display_url": "bbc.in/2FMDqGj",
"expanded_url": "http://bbc.in/2FMDqGj",
"url": "https://t.co/etehCIRwNP"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EOQDghyW4AUlKCA.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"medium": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"small": {
"w": 680,
"h": 385,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 31910,
"comment_count": 0,
"share_count": 13216
},
"content_score": 22.928688,
"media_score": 22.928688,
"metas": {
"reference_code": "twitter",
"reference_id": "1217101659379314694",
"reference_user_id": "19701628"
},
"updated_at": "2020-01-15T15:19:53.42215079Z",
"created_at": "2020-01-14T15:10:22Z"
},
{
"id": "5e1f29381728f60160d2730c",
"user": {
"id": "5e1f29381728f60160d272fb",
"first_name": "102.7",
"last_name": "KIIS FM",
"username": "reference_twitter_1027KIISFM",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1212850319236853762/Q98naPuO_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "19046392",
"reference_unique_id": "twitter.19046392"
}
},
"text": "Win 2 FREE tickets to @BTS_twt // @BTS_bighit 's @iHeartRadio LIVE event on 1/27 🎤! \n\nWho'd be your plus one? \n\nEnter for your chance here 🙌! #iHeartBTS #BTS #Army #BTSArmy (Presented by @HotTopic )\n\nhttps://t.co/iZFwTPSMa9 https://t.co/DJEbYVXGeg",
"entities": {
"hashtags": [
{
"indices": [
142,
152
],
"text": "iHeartBTS"
},
{
"indices": [
153,
157
],
"text": "BTS"
},
{
"indices": [
158,
163
],
"text": "Army"
},
{
"indices": [
164,
172
],
"text": "BTSArmy"
}
],
"urls": [
{
"indices": [
200,
223
],
"display_url": "kiisfm.iheart.com/contests/ihear…",
"expanded_url": "https://kiisfm.iheart.com/contests/iheartradio-live-with-bts-presented-by-762956/",
"url": "https://t.co/iZFwTPSMa9"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EORvNPVU0AIyugk.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1080,
"h": 1080,
"resize": "fit"
},
"medium": {
"w": 1080,
"h": 1080,
"resize": "fit"
},
"small": {
"w": 680,
"h": 680,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 5109,
"comment_count": 0,
"share_count": 2050
},
"content_score": 22.86353,
"media_score": 22.86353,
"metas": {
"reference_code": "twitter",
"reference_id": "1217220078019629058",
"reference_user_id": "19046392"
},
"updated_at": "2020-01-15T15:19:53.422300706Z",
"created_at": "2020-01-14T23:00:56Z"
}
]
+ 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": "5e1f3e2b1728f6292ae28586",
"first_name": "Carla",
"last_name": "Angola TV",
"username": "reference_twitter_carlaangola",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1187033996317941760/lHm2aF5R_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 608,
"followers_count": 2524048,
"friends_count": 2340,
"statuses_count": 34600,
"influencer_score": 29.527605,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "72627916",
"reference_unique_id": "twitter.72627916"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
},
{
"id": "5e1f331a1728f61556163fe9",
"first_name": "Donald",
"last_name": "J. Trump",
"username": "reference_twitter_realDonaldTrump",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/874276197357596672/kUuht00m_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 6,
"followers_count": 70983414,
"friends_count": 47,
"statuses_count": 47878,
"influencer_score": 28.050983,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "25073877",
"reference_unique_id": "twitter.25073877"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
},
{
"id": "5e1f3e2b1728f6292ae28583",
"first_name": "Ninja",
"last_name": "",
"username": "reference_twitter_Ninja",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1099322528223227905/ywu-iSOi_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 17785,
"followers_count": 5402541,
"friends_count": 1247,
"statuses_count": 39553,
"influencer_score": 27.568521,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "214201922",
"reference_unique_id": "twitter.214201922"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
}
]
+ 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}{?query}{?lat,lng,radius}{?sort}]
Get list of trending contents by interest category.
+ Parameters
+ category_id (required, string) - Interest category ID
+ query (optional, string) - Query for searching tweets.
+ lat (optional, number) - Location's latitude for searching tweets by location.
+ lng (optional, number) - Location's longitude for searching tweets by location.
+ radius (optional, number) - Radius for searching tweets by location. Accept unit `mil` (mile) and `km` (kilometer). Default `10km`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1de33d1728f600c7d0dbc8",
"user": {
"id": "5e1de4f01728f604b5726517",
"first_name": "BBC",
"last_name": "",
"username": "reference_twitter_BBC",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1110178686450483200/F5-Jmzk7_normal.png",
"metas": {
"reference_code": "twitter",
"reference_id": "19701628",
"reference_unique_id": "twitter.19701628"
}
},
"text": "A hot air balloon made of recycled plastic bags will fly from London to Seoul as part of an art project launched by @BTS_twt.\n#BTS #ARMY \n👉 https://t.co/etehCIRwNP https://t.co/5PjWBrR18Q",
"entities": {
"hashtags": [
{
"indices": [
126,
130
],
"text": "BTS"
},
{
"indices": [
131,
136
],
"text": "ARMY"
}
],
"urls": [
{
"indices": [
140,
163
],
"display_url": "bbc.in/2FMDqGj",
"expanded_url": "http://bbc.in/2FMDqGj",
"url": "https://t.co/etehCIRwNP"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EOQDghyW4AUlKCA.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"medium": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"small": {
"w": 680,
"h": 385,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 32195,
"comment_count": 0,
"share_count": 13298
},
"content_score": 22.923088,
"media_score": 22.923088,
"metas": {
"reference_code": "twitter",
"reference_id": "1217101659379314694",
"reference_user_id": "19701628"
},
"updated_at": "2020-01-15T16:31:50.846033237Z",
"created_at": "2020-01-14T15:10:22Z"
}
]
+ 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}{?query}{?lat,lng,radius}{?filter}{?sort}]
Get list of trending medias by interest category.
+ Parameters
+ category_id (required, string) - Interest category ID
+ query (optional, string) - Query for searching tweets.
+ lat (optional, number) - Location's latitude for searching tweets by location.
+ lng (optional, number) - Location's longitude for searching tweets by location.
+ radius (optional, number) - Radius for searching tweets by location. Accept unit `mil` (mile) and `km` (kilometer). Default `10km`.
+ filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTA2ODAyNDYsIm5iZiI6MTU1MDY4MDI0NiwianRpIjoiNGU0OGRhOTUtZDEyMS00MmViLWE4MWQtNGE4YmUzNzQ1NDNkIiwiZXhwIjoxNTUwNjgxMTQ2LCJpZGVudGl0eSI6IjVjNmQ0NmYyMzlkYThlMDA0NTkzMzczYyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.qAuvOPCQVr3YAFuD6B4RmqLmEokv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1de33d1728f600c7d0dbc8",
"user": {
"id": "5e1de4f01728f604b5726517",
"first_name": "BBC",
"last_name": "",
"username": "reference_twitter_BBC",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1110178686450483200/F5-Jmzk7_normal.png",
"metas": {
"reference_code": "twitter",
"reference_id": "19701628",
"reference_unique_id": "twitter.19701628"
}
},
"text": "A hot air balloon made of recycled plastic bags will fly from London to Seoul as part of an art project launched by @BTS_twt.\n#BTS #ARMY \n👉 https://t.co/etehCIRwNP https://t.co/5PjWBrR18Q",
"entities": {
"hashtags": [
{
"indices": [
126,
130
],
"text": "BTS"
},
{
"indices": [
131,
136
],
"text": "ARMY"
}
],
"urls": [
{
"indices": [
140,
163
],
"display_url": "bbc.in/2FMDqGj",
"expanded_url": "http://bbc.in/2FMDqGj",
"url": "https://t.co/etehCIRwNP"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EOQDghyW4AUlKCA.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"medium": {
"w": 1032,
"h": 584,
"resize": "fit"
},
"small": {
"w": 680,
"h": 385,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 31910,
"comment_count": 0,
"share_count": 13216
},
"content_score": 22.928688,
"media_score": 22.928688,
"metas": {
"reference_code": "twitter",
"reference_id": "1217101659379314694",
"reference_user_id": "19701628"
},
"updated_at": "2020-01-15T15:19:53.42215079Z",
"created_at": "2020-01-14T15:10:22Z"
},
{
"id": "5e1f29381728f60160d2730c",
"user": {
"id": "5e1f29381728f60160d272fb",
"first_name": "102.7",
"last_name": "KIIS FM",
"username": "reference_twitter_1027KIISFM",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1212850319236853762/Q98naPuO_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "19046392",
"reference_unique_id": "twitter.19046392"
}
},
"text": "Win 2 FREE tickets to @BTS_twt // @BTS_bighit 's @iHeartRadio LIVE event on 1/27 🎤! \n\nWho'd be your plus one? \n\nEnter for your chance here 🙌! #iHeartBTS #BTS #Army #BTSArmy (Presented by @HotTopic )\n\nhttps://t.co/iZFwTPSMa9 https://t.co/DJEbYVXGeg",
"entities": {
"hashtags": [
{
"indices": [
142,
152
],
"text": "iHeartBTS"
},
{
"indices": [
153,
157
],
"text": "BTS"
},
{
"indices": [
158,
163
],
"text": "Army"
},
{
"indices": [
164,
172
],
"text": "BTSArmy"
}
],
"urls": [
{
"indices": [
200,
223
],
"display_url": "kiisfm.iheart.com/contests/ihear…",
"expanded_url": "https://kiisfm.iheart.com/contests/iheartradio-live-with-bts-presented-by-762956/",
"url": "https://t.co/iZFwTPSMa9"
}
],
"medias": [
{
"source": "twitter",
"type": "image",
"url": "http://pbs.twimg.com/media/EORvNPVU0AIyugk.jpg",
"sizes": {
"thumb": {
"w": 150,
"h": 150,
"resize": "crop"
},
"large": {
"w": 1080,
"h": 1080,
"resize": "fit"
},
"medium": {
"w": 1080,
"h": 1080,
"resize": "fit"
},
"small": {
"w": 680,
"h": 680,
"resize": "fit"
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 5109,
"comment_count": 0,
"share_count": 2050
},
"content_score": 22.86353,
"media_score": 22.86353,
"metas": {
"reference_code": "twitter",
"reference_id": "1217220078019629058",
"reference_user_id": "19046392"
},
"updated_at": "2020-01-15T15:19:53.422300706Z",
"created_at": "2020-01-14T23:00:56Z"
}
]
+ 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."
}
### Trend Feed [GET /trends/feed{?query}{?category_id}{?lat,lng,radius}{?sort}{?filter}]
Get list of tweets for Trends Feed page.
+ Parameters
+ query (optional, string) - Query to search tweets.
+ category_id (optional, string) - Category ID to search.
+ lat (optional, number) - Geocode's latitude.
+ lng (optional, number) - Geocode's longitude.
+ radius (optional, string) - Geocode's radius. Accept units `mil` (mile) and `km` (kilometer). Ex: `10mil`, `100km`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1f40081728f6292ae285a4",
"user": {
"id": "5e1f3e2b1728f6292ae28587",
"first_name": "Felipe",
"last_name": "Neto",
"username": "reference_twitter_felipeneto",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1160988013599571969/wMUqo4_r_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "14128609",
"reference_unique_id": "twitter.14128609"
}
},
"text": "“Todos são iguais perante a lei” - seu cu. https://t.co/tIdIHMbjCz",
"entities": {
"hashtags": [],
"urls": [
{
"indices": [
43,
66
],
"display_url": "twitter.com/haddaddebochad…",
"expanded_url": "https://twitter.com/haddaddebochado/status/1217436333154689024",
"url": "https://t.co/tIdIHMbjCz"
}
],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 18871,
"comment_count": 0,
"share_count": 7138
},
"content_score": 22.744434,
"media_score": 22.744434,
"metas": {
"reference_code": "twitter",
"reference_id": "1217479621714817024",
"reference_user_id": "14128609"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:12:16Z"
},
{
"id": "5e1f40081728f6292ae285a3",
"user": {
"id": "5e1f3e2b1728f6292ae2858c",
"first_name": "Adam",
"last_name": "Schiff",
"username": "reference_twitter_RepAdamSchiff",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/816361054699667458/0DVL6HrY_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "29501253",
"reference_unique_id": "twitter.29501253"
}
},
"text": "I'm humbled by the solemn responsibility of serving as lead House Manager in the Senate impeachment trial.\n \nTogether, the Managers will work on behalf of the American people in defense of our Constitution.\n \nThe House upheld our Constitutional duty. The Senate must do the same.",
"entities": {
"hashtags": [],
"urls": [],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 18200,
"comment_count": 0,
"share_count": 3241
},
"content_score": 21.51159,
"media_score": 21.51159,
"metas": {
"reference_code": "twitter",
"reference_id": "1217476087292289027",
"reference_user_id": "29501253"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T15:58:13Z"
},
{
"id": "5e1f40081728f6292ae285a0",
"user": {
"id": "5e1df3651728f619d9cf29bb",
"first_name": "luscas",
"last_name": "",
"username": "reference_twitter_luscas",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1212565269459144709/AcfQfejA_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "432983617",
"reference_unique_id": "twitter.432983617"
}
},
"text": "o estado de espírito q espero atingir algum dia eh o dessas pessoas https://t.co/1hYE45T7r4",
"entities": {
"hashtags": [],
"urls": [
{
"indices": [
68,
91
],
"display_url": "twitter.com/alwayshharry/s…",
"expanded_url": "https://twitter.com/alwayshharry/status/1217251692850425856",
"url": "https://t.co/1hYE45T7r4"
}
],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 11920,
"comment_count": 0,
"share_count": 3800
},
"content_score": 22.417303,
"media_score": 22.417303,
"metas": {
"reference_code": "twitter",
"reference_id": "1217475257495425026",
"reference_user_id": "432983617"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T15:54:55Z"
}
]
## Group Tweets
### Search posts (by Twitter) [GET /tweets{?query}{?lat,lng,radius}{?sort}{?filter}]
Use Twitter search engine to search their tweets and create mirror posts to our database.
+ Parameters
+ query (optional, string) - Query to search tweets.
+ lat (optional, number) - Geocode's latitude.
+ lng (optional, number) - Geocode's longitude.
+ radius (optional, string) - Geocode's radius. Accept units `mil` (mile) and `km` (kilometer). Ex: `10mil`, `100km`.
+ sort (optional, string) - Sort type. Accepted values `top` `latest`, default is `latest`.
+ filter (optional, string) - Filter tweets. Accept values: `media` `images` `videos`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1f40081728f6292ae285a4",
"user": {
"id": "5e1f3e2b1728f6292ae28587",
"first_name": "Felipe",
"last_name": "Neto",
"username": "reference_twitter_felipeneto",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1160988013599571969/wMUqo4_r_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "14128609",
"reference_unique_id": "twitter.14128609"
}
},
"text": "“Todos são iguais perante a lei” - seu cu. https://t.co/tIdIHMbjCz",
"entities": {
"hashtags": [],
"urls": [
{
"indices": [
43,
66
],
"display_url": "twitter.com/haddaddebochad…",
"expanded_url": "https://twitter.com/haddaddebochado/status/1217436333154689024",
"url": "https://t.co/tIdIHMbjCz"
}
],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 18871,
"comment_count": 0,
"share_count": 7138
},
"content_score": 22.744434,
"media_score": 22.744434,
"metas": {
"reference_code": "twitter",
"reference_id": "1217479621714817024",
"reference_user_id": "14128609"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:12:16Z"
},
{
"id": "5e1f40081728f6292ae285a3",
"user": {
"id": "5e1f3e2b1728f6292ae2858c",
"first_name": "Adam",
"last_name": "Schiff",
"username": "reference_twitter_RepAdamSchiff",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/816361054699667458/0DVL6HrY_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "29501253",
"reference_unique_id": "twitter.29501253"
}
},
"text": "I'm humbled by the solemn responsibility of serving as lead House Manager in the Senate impeachment trial.\n \nTogether, the Managers will work on behalf of the American people in defense of our Constitution.\n \nThe House upheld our Constitutional duty. The Senate must do the same.",
"entities": {
"hashtags": [],
"urls": [],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 18200,
"comment_count": 0,
"share_count": 3241
},
"content_score": 21.51159,
"media_score": 21.51159,
"metas": {
"reference_code": "twitter",
"reference_id": "1217476087292289027",
"reference_user_id": "29501253"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T15:58:13Z"
},
{
"id": "5e1f40081728f6292ae285a0",
"user": {
"id": "5e1df3651728f619d9cf29bb",
"first_name": "luscas",
"last_name": "",
"username": "reference_twitter_luscas",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1212565269459144709/AcfQfejA_normal.jpg",
"metas": {
"reference_code": "twitter",
"reference_id": "432983617",
"reference_unique_id": "twitter.432983617"
}
},
"text": "o estado de espírito q espero atingir algum dia eh o dessas pessoas https://t.co/1hYE45T7r4",
"entities": {
"hashtags": [],
"urls": [
{
"indices": [
68,
91
],
"display_url": "twitter.com/alwayshharry/s…",
"expanded_url": "https://twitter.com/alwayshharry/status/1217251692850425856",
"url": "https://t.co/1hYE45T7r4"
}
],
"medias": []
},
"reaction": {
"liked": false,
"like_count": 11920,
"comment_count": 0,
"share_count": 3800
},
"content_score": 22.417303,
"media_score": 22.417303,
"metas": {
"reference_code": "twitter",
"reference_id": "1217475257495425026",
"reference_user_id": "432983617"
},
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T15:54:55Z"
}
]
### Like a tweet/post [POST /tweets/{id}/likes]
Like a tweet.
+ Parameters
+ id (required, string) - The internal ID of tweet.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
{
"like_count": 9,
"comment_count": 0,
"liked": true
}
+ Response 400 (application/json)
{
"http_code": 400,
"code": "liked_already",
"message": "You have liked this post already"
}
### Un-like a tweet/post [DELETE /tweets/{id}/likes]
Un-like a tweet.
+ Parameters
+ id (required, string) - The internal ID of tweet.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
{
"like_count": 8,
"comment_count": 0,
"liked": false
}
### Get comments [GET /tweets/{id}/comments]
Get list comments of a tweet.
+ Parameters
+ id (required, string) - The internal ID of tweet.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5dade5185a46edf3c0dc57f7",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "How is it going on?",
"medias": [
{
"source": "google_storage",
"type": "video",
"url": "https://storage.googleapis.com/trendai-static/comments/5daddc6dceeabb04cd39f801/ktovygzqolrapuyw.mp4"
}
]
},
{
"id": "5dade48c5a46edf3c0dc4b98",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Quynh",
"last_name": "Le",
"username": "quynhle",
"email": "quynhle@gmail.com",
"gender": "female",
"dob": "1996-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "How is it going on?",
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/comment/5daddc6dceeabb04cd39f801/jxerdqjmxisnwckv.jpg"
}
]
},
{
"id": "5daddd905a46edf3c0dc0156",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "See my image",
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/comment/5daddc6dceeabb04cd39f801/zwawgdlqxvhoduic.jpg"
}
]
},
{
"id": "5daddd6c5a46edf3c0dc014d",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "This is a great post",
}
]
### Post a comment [POST /tweets/{id}/comments]
Post a comment to a tweet.
+ Parameters
+ id (required, string) - The internal ID of tweet.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Body
-----BOUNDARY
Content-Disposition: form-data; name="text"
Hey, see my photo
-----BOUNDARY
Content-Disposition: form-data; name="media"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
+ Response 200 (application/json)
[
{
"id": "5dade5185a46edf3c0dc57f7",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "How is it going on?",
"medias": [
{
"source": "google_storage",
"type": "video",
"url": "https://storage.googleapis.com/trendai-static/comments/5daddc6dceeabb04cd39f801/ktovygzqolrapuyw.mp4"
}
]
},
{
"id": "5dade48c5a46edf3c0dc4b98",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Quynh",
"last_name": "Le",
"username": "quynhle",
"email": "quynhle@gmail.com",
"gender": "female",
"dob": "1996-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "How is it going on?",
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/comment/5daddc6dceeabb04cd39f801/jxerdqjmxisnwckv.jpg"
}
]
},
{
"id": "5daddd905a46edf3c0dc0156",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "See my image",
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/comment/5daddc6dceeabb04cd39f801/zwawgdlqxvhoduic.jpg"
}
]
},
{
"id": "5daddd6c5a46edf3c0dc014d",
"user": {
"id": "5d8b7b34f75f7304a0786040",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1994-05-11T00:00:00Z",
"avatar_url": "https://storage.googleapis.com/trendai-static/avatar/5d8b7b34f75f7304a0786040-vvcqpfzikougiupy.jpg",
"banner_url": "https://storage.googleapis.com/trendai-static/banner/5d8b7b34f75f7304a0786040-obelxrvehkdkyrhw.jpg"
},
"text": "This is a great post",
}
]
+ Response 400 (application/json)
{
"http_code": 400,
"code": "missing_message",
"message": "Please input a text message"
}
## Group Influencers
### Search influencers [GET /influencers{?query}{?lat,lng,radius}]
Search influencers by tweet contents.
+ Parameters
+ query (optional, string) - Query to search influencers by tweets.
+ lat (optional, number) - Geocode's latitude.
+ lng (optional, number) - Geocode's longitude.
+ radius (optional, string) - Geocode's radius. Accept units `mil` (mile) and `km` (kilometer). Ex: `10mil`, `100km`.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1f3e2b1728f6292ae28586",
"first_name": "Carla",
"last_name": "Angola TV",
"username": "reference_twitter_carlaangola",
"email": "",
"gender": "other",
"dob": "0001-01-01T00:00:00Z",
"education": "",
"avatar_url": "https://pbs.twimg.com/profile_images/1187033996317941760/lHm2aF5R_normal.jpg",
"banner_url": "https://abs.twimg.com/images/themes/theme1/bg.png",
"location": {
"lat": 0,
"lng": 0
},
"external_users": [],
"interest_categories": [],
"favourites_count": 608,
"followers_count": 2524048,
"friends_count": 2340,
"statuses_count": 34600,
"influencer_score": 29.527605,
"tweet_stat": {
"reply_count": 0,
"retweet_count": 0,
"favorite_count": 0
},
"subscriptions": [],
"metas": {
"reference_code": "twitter",
"reference_id": "72627916",
"reference_unique_id": "twitter.72627916"
},
"premium": true,
"created_at": "0001-01-01T00:00:00Z"
}
]
## Group Posts
### Search posts [GET /posts{?created_by_me}]
Search posts with filter.
+ Parameters
+ created_by_me (optional, boolean) - Search posts that was created by me.
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Response 200 (application/json)
[
{
"id": "5e1f416e1728f6292ae285a6",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "Welcome to TrendAI!",
"location": {
"lat": 21.02762343538634,
"lng": 105.82435990401002,
"address": "123 Giai Phong, Ha Noi"
},
"entities": {
"hashtags": [],
"urls": [],
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/posts/5e1f416e1728f6292ae285a6/5e1f416e1728f6292ae285a6-fjgdtompqilmnmeo.jpeg",
"sizes": {
"thumb": {
"w": 0,
"h": 0,
"resize": ""
},
"large": {
"w": 0,
"h": 0,
"resize": ""
},
"medium": {
"w": 0,
"h": 0,
"resize": ""
},
"small": {
"w": 0,
"h": 0,
"resize": ""
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": []
}
}
]
},
"reaction": {
"liked": false,
"like_count": 0,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "2020-01-15T16:44:31.711Z",
"created_at": "2020-01-15T16:44:30.456Z"
},
{
"id": "5e1f392f1728f6212f9d8aa1",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "This is my first post",
"location": {
"lat": 21.02762343538634,
"lng": 105.82435990401002,
"address": "123 Giai Phong, Ha Noi"
},
"reaction": {
"liked": false,
"like_count": 0,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "0001-01-01T00:00:00Z",
"created_at": "2020-01-15T16:09:19.983Z"
}
]
### Create post [GET /posts]
Create a post with text or medias (image, video).
+ Request (application/json)
+ Headers
Authorization: Bearer eyJ0eXAiOiJIUzI1NiJ9.eyJNkIiwiFjY2VzcyJ9.qAuv-05ttL8BzPRBAug
+ Body
-----BOUNDARY
Content-Disposition: form-data; name="text"
Welcome to TrendAI
-----BOUNDARY
Content-Disposition: form-data; name="media"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
Content-Disposition: form-data; name="lat"
21.02762343538634
-----BOUNDARY
Content-Disposition: form-data; name="lng"
105.82435990401002
-----BOUNDARY
Content-Disposition: form-data; name="address"
321 Nguyen Trai, Thanh Xuan, Ha Noi
-----BOUNDARY
+ Response 200 (application/json)
{
"id": "5e1f416e1728f6292ae285a6",
"user": {
"id": "5ddd385e4f037d11b3943d77",
"first_name": "Thang",
"last_name": "Bui",
"username": "zenthangplus",
"email": "zenthangplus@gmail.com",
"gender": "male",
"dob": "1996-05-11T00:00:00Z",
"education": "",
"avatar_url": ""
},
"text": "Welcome to TrendAI",
"location": {
"lat": 21.02762343538634,
"lng": 105.82435990401002,
"address": "321 Nguyen Trai, Thanh Xuan, Ha Noi"
},
"entities": {
"hashtags": [],
"urls": [],
"medias": [
{
"source": "google_storage",
"type": "image",
"url": "https://storage.googleapis.com/trendai-static/posts/5e1f416e1728f6292ae285a6/5e1f416e1728f6292ae285a6-fjgdtompqilmnmeo.jpeg",
"sizes": {
"thumb": {
"w": 0,
"h": 0,
"resize": ""
},
"large": {
"w": 0,
"h": 0,
"resize": ""
},
"medium": {
"w": 0,
"h": 0,
"resize": ""
},
"small": {
"w": 0,
"h": 0,
"resize": ""
}
},
"video_info": {
"aspect_ratio": [
0,
0
],
"duration_millis": 0,
"variants": null
}
}
]
},
"reaction": {
"liked": false,
"like_count": 0,
"comment_count": 0,
"share_count": 0
},
"content_score": 0,
"media_score": 0,
"updated_at": "2020-01-15T16:44:31.711429013Z",
"created_at": "2020-01-15T16:44:30.456870987Z"
}
# 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)
