Taringa! Brainiac API documentation

/auth

/auth/login get

get

/auth/callback get

get

/auth/register get

get

/auth/logout post

post

/auth/facebook/token post

post

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  token_type: 'Bearer',
  access_token: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ0',
  refresh_token: 'IjoicmVmcmVzaF90b2tlbiIsImlkIjoiTmJ4SXIi',
  expires_in: 3600
}

/auth/google/authcode post

post

/auth/signup/complete post

post

/oauth/v2

/oauth/v2/token post

post

/user

/user/tops get

get

/user/username/{username} get

get

/user/tid/{tid} get

get

/user/id/{id} get

get

/user/about get

get

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'user',
  tid: 1,
  username: 'test',
  firstname: 'first name',
  followers: 0,
  following: 0,
  lastname: 'last name',
  birthday: '1988-05-27',
  avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
  background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
  site: 'http://hello.w0r1d.net/',
  gender: 'm',
  country: 'AR',
  message: 'Hello World!',
  rank: 'User',
  suspended: false,
}

/user/{username}/about get

get

Request
Response

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'user',
  tid: 1,
  username: 'test',
  firstname: 'first name',
  followers: 0,
  following: 0,
  lastname: 'last name',
  birthday: '1988-05-27',
  avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
  background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
  site: 'http://hello.w0r1d.net/',
  gender: 'm',
  country: 'AR',
  message: 'Hello World!',
  rank: 'User',
  suspended: false,
}

/user/new post

post

Request
Response

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "username": {
        "type": "string",
        "minLength": 1
      },
      "firstname": { "type": "string" },
      "lastname": { "type": "string" },
      "birthday": { "type": "string" },
      "avatar": { "type": "string" },
      "background": { "type": "string" },
      "site": { "type": "string" },
      "gender": { "type": "string" },
      "country": { "type": "string" },
      "message": { "type": "string" },
      "email": { "type": "string" },
      "password": { "type": "string" },
      "captcha": { "type": "string" }
    },
    "required": ["username", "firstname", "lastname", "email"],
    "additionalProperties": false
  }

HTTP status code 201

/user/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "username": { "type": "string" },
    "firstname": { "type": "string" },
    "lastname": { "type": "string" },
    "birthday": { "type": "string" },
    "avatar": { "type": "string" },
    "background": { "type": "string" },
    "site": { "type": "string" },
    "gender": { "type": "string" },
    "country": { "type": "string" },
    "message": { "type": "string" },
    "wallpaper": { "type": "string" },
    "wallpaperMode": { "type": "string" },
    "migrated": { "type": "array" }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'user',
  tid: 1,
  username: 'test',
  firstname: 'first name',
  followers: 0,
  following: 0,
  lastname: 'last name',
  birthday: '1988-05-27',
  avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
  background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
  site: 'http://hello.w0r1d.net/',
  gender: 'm',
  country: 'AR',
  message: 'Hello World!',
  rank: 'User',
}

/user/{username}/moderate post

post

Request
Response

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "reason": { "type": "string" },
    "user": {
      "type": "object",
      "properties": {
        "avatar": { "type": "string" },
        "background": { "type": "string" },
        "wallpaper": { "type": "string" }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'user',
  tid: 1,
  username: 'test',
  firstname: 'first name',
  followers: 0,
  following: 0,
  lastname: 'last name',
  birthday: '1988-05-27',
  avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
  background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
  site: 'http://hello.w0r1d.net/',
  gender: 'm',
  country: 'AR',
  message: 'Hello World!',
  rank: 'User',
}

/user/settings/firstsession/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/skipTutorial/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/siteNotifications/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/enableVideoAutoplay/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/enableBetaTesting/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/lang/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/ntf/{device}/patch post

post

Request
Response

URI Parameters

device: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings get

get

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  notifications: {
    user-followed: true,
    user-mentioned: true,
    comment-reply-created: true,
    story-voted: false,
    comment-created: false,
    channel-subscribed: true,
    story-created: true,
  }
}

/user/settings/nsfw/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/settings/push/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "comment-created": { "type": "boolean" },
        "comment-reply-created": { "type": "boolean" },
        "user-subscribed": { "type": "boolean" },
        "story-voted": { "type": "boolean" },
        "story-created": { "type": "boolean" },
        "story-shared": { "type": "boolean" },
        "user-followed": { "type": "boolean" },
        "user-mentioned": { "type": "boolean" },
        "user-requested-subscription": { "type": "boolean" },
        "user-was-accepted": { "type": "boolean" }
      },
      "additionalProperties": false
    },
    "firstSession": {
      "oneOf": [
        { "type": "null" },
        { "enum": [
          "interests",
          "follow-users",
          "done"
        ] }
      ]
    },
    "skipTutorial": {
      "type": "boolean"
    },
    "enableSiteNotifications": {
      "type": "boolean"
    },
    "enableVideoAutoplay": {
      "type": "boolean"
    },
    "enableBetaTesting": {
      "type": "boolean"
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    },
    "lang": {
      "enum": ["es", "en"]
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/user/preferences/channel/{name}/dismiss post

post

/user/preferences get

get

/user/notifications get

get

/user/notifications/notseen get

get

/user/notifications/{ntfId}/read post

post

/user/notifications/{ntfId}/unread post

post

/user/notifications/{ntfId}/delete post

post

/user/notifications/seen post

post

/user/notifications/read post

post

/user/notifications/silence/{object} post

post

/user/{username}/patch post

post

Request
Response

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "username": { "type": "string" },
    "firstname": { "type": "string" },
    "lastname": { "type": "string" },
    "birthday": { "type": "string" },
    "avatar": { "type": "string" },
    "background": { "type": "string" },
    "site": { "type": "string" },
    "gender": { "type": "string" },
    "country": { "type": "string" },
    "message": { "type": "string" },
    "wallpaper": { "type": "string" },
    "wallpaperMode": { "type": "string" },
    "migrated": { "type": "array" }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'user',
  tid: 1,
  username: 'test',
  firstname: 'first name',
  followers: 0,
  following: 0,
  lastname: 'last name',
  birthday: '1988-05-27',
  avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
  background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
  site: 'http://hello.w0r1d.net/',
  gender: 'm',
  country: 'AR',
  message: 'Hello World!',
  rank: 'User',
}

/user/suggest get

get

/user/recommended get

get

/user/list/followers/{period} get

get

Returns a list of users ordered by followers in a determined period

/user/list/popular get

get

Returns a list of users ordered by a score based in the last week followers

/user/subscriptions get

get

/user/subscriptions/search get

get

/user/{username}/subscriptions get

get

/user/{username}/c/subscriptions get

get

/user/{username}/c/administrated get

get

Returns a list of channels administrated by the user

/user/follow post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1
  },
  "minLength": 1
}

HTTP status code 200

/user/{username}/follow post

post

/user/{username}/unfollow post

post

/user/{username}/following get

get

/user/{username}/followers get

get

/user/{username}/feed get

get

/user/{username}/tops/{period} get

get

/user/{username}/applications get

get

Request
Response

URI Parameters

username: required (string)

Query Parameters

sort: (string)
after: (string)
before: (string)
count: (integer)
summary: (boolean)
page: (integer)
nsfw: (boolean)
q: (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  after: 'rm23gsa',
  before: 'rm23gsa',
  count: 1,
  totalCount: 1,
  items: [
    {
      id: 'rm23gsa',
      created: '2016-05-27T17:07:16.000Z',
      name: 'The Best Application',
      type: 'application:summary'
    }
  ]
}

/user/{username}/report post

post

Request
Response

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "required": ["reason"],
  "additionalProperties": false
}

HTTP status code 201

/user/{username}/c/created get

get

/user/{username}/block post

post

/user/{username}/unblock post

post

/user/{username}/suspensions get

get

/user/{username}/suspend post

post

/user/{username}/unsuspend post

post

/user/{username}/comments get

get

/user/{username}/stories/deleted get

get

/user/{username}/stories/liked get

get

/user/{username}/comments/deleted get

get

/user/{username}/channels/deleted get

get

/user/{username}/changelog get

get

/user/{username}/friends get

get

/user/blocks/list get

get

Returns a list of user objects that the authenticating user is blocking.

/user/{username}/available get

get

Checks if the username is available

/user/delete/check get

get

Checks if the account is local in order to perform deletion

/user/delete post

post

Delete user profile/account

/user/{username}/delete/{type} post

post

Delete all user stories, comments or channels

/user/username/suggestions post

post

Returns a list of username suggestions

Request
Response

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "firstname": { "type": "string" },
      "lastname": { "type": "string" },
      "username": { "type": "string" },
      "count": { "type": "number" }
    },
    "additionalProperties": false
  }

HTTP status code 200

Body

Type: application/json

/user/subscribe-club post

post

/account

/account/user get

get

/account/email get

get

/account/social get

get

/account/phone get

get

/account/set-phone post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "phone": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "area": {
          "type": "string",
          "minLength": 2,
          "maxLength": 4
        },
        "number": {
          "type": "string",
          "minLength": 6,
          "maxLength": 15
        }
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

/account/send-sms post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "phone": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "area": {
          "type": "string",
          "minLength": 2,
          "maxLength": 4
        },
        "number": {
          "type": "string",
          "minLength": 6,
          "maxLength": 15
        }
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

/account/email/patch post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "email": { "type": "string" },
    "password": { "type": "string" }
  },
  "required": ["email", "password"],
  "additionalProperties": false
}

HTTP status code 200

/account/email/confirm post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "token": { "type": "string" }
  },
  "required": ["token"],
  "additionalProperties": false
}

HTTP status code 200

/account/reset-password/phone post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "phone": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "area": {
          "type": "string",
          "minLength": 2,
          "maxLength": 4
        },
        "number": {
          "type": "string",
          "minLength": 6,
          "maxLength": 15
        }
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

/account/not-verified get

get

/session

/session/about get

get

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'session',
  id: 'kja91',
  created: '2016-05-27T17:07:16.000Z',
  application: {
    id: 'rm23gsa',
    created: '2016-05-27T17:07:16.000Z',
    name: 'The Best Application',
    type: 'application:summary'
  },
  ip: '127.0.0.1',
  country: 'ar',
  userAgent: 'Chrome/54.0.2840.98',
  lastAccess: '2016-05-27T18:07:16.000Z',
  active: true
}

/session/{id}/about get

get

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'session',
  id: 'kja91',
  created: '2016-05-27T17:07:16.000Z',
  application: {
    id: 'rm23gsa',
    created: '2016-05-27T17:07:16.000Z',
    name: 'The Best Application',
    type: 'application:summary'
  },
  ip: '127.0.0.1',
  country: 'ar',
  userAgent: 'Chrome/54.0.2840.98',
  lastAccess: '2016-05-27T18:07:16.000Z',
  active: true
}

/session/list get

get

Response

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    type: 'session',
    id: 'kja91',
    created: '2016-05-27T17:07:16.000Z',
    application: {
      id: 'rm23gsa',
      created: '2016-05-27T17:07:16.000Z',
      name: 'The Best Application',
      type: 'application:summary'
    },
    ip: '127.0.0.1',
    country: 'ar',
    userAgent: 'Chrome/54.0.2840.98',
    lastAccess: '2016-05-27T18:07:16.000Z',
    active: true
  }
]

/session/delete post

post

/session/{username}/list get

get

Returns an array of the user sessions

Request
Response

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    type: 'session',
    id: 'kja91',
    created: '2016-05-27T17:07:16.000Z',
    application: {
      id: 'rm23gsa',
      created: '2016-05-27T17:07:16.000Z',
      name: 'The Best Application',
      type: 'application:summary'
    },
    ip: '127.0.0.1',
    country: 'ar',
    userAgent: 'Chrome/54.0.2840.98',
    lastAccess: '2016-05-27T18:07:16.000Z',
    active: true
  }
]

/session/{username}/delete/all post

post

Delete all user sessions

/session/{username}/delete/{id} post

post

Delete user session by id

/session/{id}/delete post

post

/session/delete/all post

post

/story

/story/bookmarks get

get

/story/recommended get

get

/story/bulk post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "stories": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["stories"],
  "additionalProperties": false
}

HTTP status code 200

/story/{id} get

get

/story/_random get

get

/story/{id}/summary get

get

/story/{id}/related get

get

/story/{id}/related/v2 get

get

/story/{id}/related/global get

get

/story/{id}/comments get

get

/story/{id}/comments/tops get

get

/story/{id}/voters/up get

get

/story/{id}/voters/down get

get

/story/{id}/sharers get

get

/story/{id}/bookmarkers get

get

/story/{id}/vote/up post

post

/story/{id}/vote/down post

post

/story/{id}/vote/cancel post

post

/story/{id}/delete post

post

/story/{id}/mod-delete post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "additionalProperties": false
}

HTTP status code 200

/story/{id}/restore post

post

/story/{id}/changelog get

get

/story/{id}/patch post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "title": { "type": "string", "maxLength": 70 },
    "nsfw": { "type": "boolean" },
    "globalUnsafe": { "type": "boolean" },
    "usertags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 70
      }
    },
    "sources": {
      "type": "array",
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 8
      }
    },
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["markdown"] },
              "body": { "type": "string" }
            },
            "required": ["type", "body"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "url": { "type": "string", "minLength": 8 }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "share": {
                "type": "object",
                "properties": {
                  "type": { "enum": ["story"] },
                  "id": { "type": "string", "maxLength": 20 }
                },
                "required": ["type", "id"],
                "additionalProperties": false
              }
            },
            "required": ["type", "share"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["image"] },
              "url": { "type": "string", "minLength": 8 },
              "caption": { "type": "string", "maxLength": 150 },
              "isThumbnail": { "type": "boolean" },
              "expanded": { "type": "boolean" }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

/story/{id}/report post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "required": ["reason"],
  "additionalProperties": false
}

HTTP status code 201

/story/{id}/bookmark post

post

/story/{id}/unbookmark post

post

/story/{id}/complaints get

get

/story/{id}/stats get

get

/story/{id}/ampcontent get

get

/story/draft/{id}/patch post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "title": { "type": "string", "maxLength": 70 },
    "channelName": { "type": "string", "maxLength": 70 },
    "nsfw": { "type": "boolean" },
    "usertags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string",
        "enum": ["meme"]
      }
    },
    "sources": {
      "type": "array",
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["markdown"] },
              "body": { "type": "string" }
            },
            "required": ["type", "body"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "url": { "type": "string", "minLength": 8 }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "share": {
                "type": "object",
                "properties": {
                  "type": { "enum": ["story"] },
                  "id": { "type": "string", "maxLength": 20 }
                },
                "required": ["type", "id"],
                "additionalProperties": false
              }
            },
            "required": ["type", "share"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["image"] },
              "url": { "type": "string", "minLength": 8 },
              "caption": { "type": "string", "maxLength": 150 },
              "isThumbnail": { "type": "boolean" },
              "expanded": { "type": "boolean" }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

/story/draft/{id}/delete post

post

/story/draft/new post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "title": { "type": "string", "maxLength": 70 },
    "channelName": { "type": "string", "maxLength": 70 },
    "nsfw": { "type": "boolean" },
    "usertags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string",
        "enum": ["meme"]
      }
    },
    "sources": {
      "type": "array",
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["markdown"] },
              "body": { "type": "string" }
            },
            "required": ["type", "body"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "url": { "type": "string", "minLength": 8 }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "share": {
                "type": "object",
                "properties": {
                  "type": { "enum": ["story"] },
                  "id": { "type": "string", "maxLength": 20 }
                },
                "required": ["type", "id"],
                "additionalProperties": false
              }
            },
            "required": ["type", "share"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["image"] },
              "url": { "type": "string", "minLength": 8 },
              "caption": { "type": "string", "maxLength": 150 },
              "isThumbnail": { "type": "boolean" },
              "expanded": { "type": "boolean" }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "additionalProperties": false
}

HTTP status code 201

/story/draft/list get

get

/comment

/comment/{id} get

get

/comment/new post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "parent": {
      "type": "object",
      "properties": {
        "type": { "enum": ["story", "comment"] },
        "id": {
          "type": "string",
          "minlength": 1
        }
      },
      "required": ["type", "id"],
      "additionalProperties": false
    },
    "body": {
      "type": "string"
    },
    "attachment": {
      "type": "object",
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": { "enum": ["link"] },
            "url": {
              "type": "string",
              "minLength": 8
            }
          },
          "required": ["type", "url"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": { "enum": ["image"] },
            "url": {
              "type": "string",
              "minlength": 8
            }
          },
          "required": ["type", "url"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["parent"],
  "additionalProperties": true
}

HTTP status code 201

/comment/{id}/delete post

post

/comment/{id}/mod-delete post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "storyType": { "type": "string" },
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "additionalProperties": false
}

HTTP status code 200

/comment/{id}/restore post

post

/comment/{id}/changelog get

get

/comment/{id}/vote/up post

post

/comment/{id}/vote/down post

post

/comment/{id}/vote/cancel post

post

/comment/{id}/report post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "required": ["reason"],
  "additionalProperties": false
}

HTTP status code 201

/comment/{id}/hide post

post

Set the comment as invisible

/comment/{id}/unhide post

post

Set the comment as visible

/comment/{id}/nsfw post

post

Set the comment as NSFW

/comment/{id}/sfw post

post

Set the comment as SFW

/comment/{id}/toxicity post

post

Sets the comment toxicity

/comment/{id}/moderated post

post

Run hooks when a comment has been moderated

/c

/c/{name}/about get

get

/c/{name}/changelog get

get

/c/{name}/feed get

get

/c/{name}/comments get

get

/c/{name}/tops/{period} get

get

/c/subscribe post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1
  },
  "minLength": 1
}

HTTP status code 200

/c/{name}/subscribe post

post

/c/{name}/unsubscribe post

post

/c/{name}/subscribers get

get

/c/{name}/accept/{username} post

Accepts the {username} request to join a restricted channel.

post

/c/{name}/accept post

Accepts all the requests to join {name} restricted channel.

post

/c/{name}/kick/{username} post

Rejects the {username} request to join a restricted channel, or kick the user out of the channel.

post

/c/{name}/kick post

Rejects all the requests to join {name} restricted channel.

post

/c/{name}/pending get

get

/c/{name}/ban/{username} post

post

/c/{name}/unban/{username} post

post

/c/{name}/banned get

get

/c/{name}/new post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "title": { "type": "string", "maxLength": 70 },
    "nsfw": { "type": "boolean" },
    "bot": { "type": "boolean" },
    "usertags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 70
      }
    },
    "sources": {
      "type": "array",
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 8
      }
    },
    "tags": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 10,
      "items": {
        "type": "string",
        "enum": ["meme"]
      }
    },
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["markdown"] },
              "body": { "type": "string" }
            },
            "required": ["type", "body"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "url": { "type": "string", "minLength": 8 }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["link"] },
              "share": {
                "type": "object",
                "properties": {
                  "type": { "enum": ["story"] },
                  "id": { "type": "string", "maxLength": 20 }
                },
                "required": ["type", "id"],
                "additionalProperties": false
              }
            },
            "required": ["type", "share"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["image"] },
              "url": { "type": "string", "minLength": 8 },
              "caption": { "type": "string", "maxLength": 150 },
              "isThumbnail": { "type": "boolean" },
              "expanded": { "type": "boolean" }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "type": { "enum": ["divider"] }
            },
            "additionalProperties": false
          }
        ]
      }
    },
    "challenge": { "type": "string" }
  },
  "required": ["title", "content"],
  "additionalProperties": false
}

HTTP status code 201

/c/{name}/patch post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 25
    },
    "title": { "type": "string" },
    "thumbnail": { "type": "string" },
    "channelType": { "type": "string", "enum": ["public", "restricted"] },
    "publishingRules": {
      "type": "object",
      "properties": {
        "story": { "type": "string", "enum": ["PR_ALL", "PR_MEMBERS_ONLY", "PR_ADMINS_ONLY"] },
        "comment": { "type": "string", "enum": ["PR_COMMENT_ALL", "PR_COMMENT_MEMBERS_ONLY", "PR_COMMENT_ADMINS_ONLY"] }
      }
    },
    "background": { "type": "string" },
    "description": { "type": "string" },
    "rules": { "type": "string" },
    "category": { "type": "string" },
    "nsfw": { "type": "boolean" }
  },
  "additionalProperties": false
}

HTTP status code 200

/c/{name}/report post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "reason": { "type": "string" },
    "subReason": { "type": "string" },
    "message": { "type": "string", "maxLength": 1024 }
  },
  "required": ["reason"],
  "additionalProperties": false
}

HTTP status code 201

/c/{name}/delete post

post

/c/{name}/restore post

post

/c/{name}/roles/assign post

post

Assign a role to a user. The user must be a member of the channel.

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "username": {
      "type": "string",
      "required": true
    },
    "role": {
      "type": { "enum": ["moderator", "editor", "administrator"] },
      "required": true
    }
  }
}

Example:

{
  "user": "manolo",
  "role": "moderator"
}

HTTP status code 200

/c/{name}/roles/remove post

post

Removes the role of the user. The user must be a member of the channel.

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "username": {
      "type": "string",
      "required": true
    }
  }
}

Example:

{
  "user": "manolo"
}

HTTP status code 200

/c/{name}/moderators get

get

/c/{name}/administrators get

get

/c/{name}/editors get

get

/c/recommended get

get

/c/new post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 25
    },
    "title": { "type": "string" },
    "thumbnail": { "type": "string" },
    "background": { "type": "string" },
    "description": { "type": "string" },
    "rules": { "type": "string" },
    "channelType": { "type": "string", "enum": ["public", "restricted"] },
    "publishingRules": {
      "type": "object",
      "properties": {
        "story": { "type": "string", "enum": ["PR_ALL", "PR_MEMBERS_ONLY", "PR_ADMINS_ONLY"] },
        "comment": { "type": "string", "enum": ["PR_COMMENT_ALL", "PR_COMMENT_MEMBERS_ONLY", "PR_COMMENT_ADMINS_ONLY"] }
      }
    },
    "nsfw": { "type": "boolean" },
    "category": { "type": "string" }
  },
  "required": [
    "name",
    "thumbnail",
    "description"
  ],
  "additionalProperties": false
}

HTTP status code 201

/c/list/activity/{period} get

get

Returns a list of channels ordered by activity in a determined period

/c/list/subscribers/{period} get

get

Returns a list of channels ordered by subscriptions in a determined period

/c/list/popular get

get

Returns a list of channels ordered by a score based in the last week subscriptions

/c/list/hot get

get

Returns a list of channels ordered by a score based in the last week activity

/c/list/recent get

get

Returns a list of channels ordered by creation date

/c/suggest get

Returns a list of channels suggested based on the query. The channels you follow have higher priority

get

/c/by-activity/{filter} get

get

/c/{name}/favorite/add post

post

/c/{name}/favorite/delete post

post

/c/{name}/seen post

post

/c/{name}/stickies get

get

/c/{name}/stickies/add post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "storyId": {
      "type": "string"
    }
  },
  "required": ["storyId"],
  "additionalProperties": false
}

HTTP status code 200

/c/{name}/stickies/delete post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "storyId": {
      "type": "string"
    }
  },
  "required": ["storyId"],
  "additionalProperties": false
}

HTTP status code 200

/c/{name}/move/stories post

Move a list of stories to this channel

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1
  },
  "minLength": 1
}

HTTP status code 200

/c/{name}/change-owner post

post

Request
Response

URI Parameters

name: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
      "username": {
      "type": "string",
      "minLength": 1
      }
  },
  "additionalProperties": false
}

HTTP status code 200

/feed

/feed/ get

get

/feed/global get

get

/feed/global/comments get

get

/feed/activity get

get

/feed/lists get

Returns the names of all the custom lists

get

/feed/list/{name} get

Returns a feed created using channels and users on the selected list

get

/feed/list/items/{name}/{entityType} get

Returns items on the list of a given type

get

/feed/list/{name}/{action} post

Create, reset and delete a list

post

/feed/list/{name}/{entityType}/{action} post

Add or remove elements of {type} to the list

post

/extract

/extract/ get

Extract metadata information from an URL.

get

/image

/image/import post

Import image from url

post

/image/upload post

upload image from base64 encoded file

post

/device

/device/list get

get

/device/add post

post

Alias to /register, for backwards compatibility

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "endpoint": { "type": "string", "minLength": 1 },
        "token": { "type": "string", "minLength": 1 },
        "keys": {
          "type": "object",
          "properties": {
            "auth": { "type": "string", "minLength": 1 },
            "p256dh": { "type": "string", "minLength": 1 }
          },
          "required": ["auth", "p256dh"],
          "additionalProperties": false
        }
      },
      "additionalProperties": true
    },
    "device": {
      "type": "object",
      "properties": {
        "type": { "enum": ["browser", "native"] },
        "lang": { "type": "string", "minLength": 1 },
        "name": { "type": "string", "minLength": 1 },
        "os": { "type": "string", "minLength": 1 },
        "version": { "type": "string", "minLength": 1 },
        "uniqueId": { "type": "string", "minLength": 1 }
      },
      "required": ["type"],
      "additionalProperties": false
    }
  },
  "required": ["device", "subscription"],
  "additionalProperties": false
}

HTTP status code 200

/device/register post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "endpoint": { "type": "string", "minLength": 1 },
        "token": { "type": "string", "minLength": 1 },
        "keys": {
          "type": "object",
          "properties": {
            "auth": { "type": "string", "minLength": 1 },
            "p256dh": { "type": "string", "minLength": 1 }
          },
          "required": ["auth", "p256dh"],
          "additionalProperties": false
        }
      },
      "additionalProperties": true
    },
    "device": {
      "type": "object",
      "properties": {
        "type": { "enum": ["browser", "native"] },
        "lang": { "type": "string", "minLength": 1 },
        "name": { "type": "string", "minLength": 1 },
        "os": { "type": "string", "minLength": 1 },
        "version": { "type": "string", "minLength": 1 },
        "uniqueId": { "type": "string", "minLength": 1 }
      },
      "required": ["type"],
      "additionalProperties": false
    }
  },
  "required": ["device", "subscription"],
  "additionalProperties": false
}

HTTP status code 200

/device/delete post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "endpoint": { "type": "string", "minLength": 1 },
        "token": { "type": "string", "minLength": 1 },
        "keys": {
          "type": "object",
          "properties": {
            "auth": { "type": "string", "minLength": 1 },
            "p256dh": { "type": "string", "minLength": 1 }
          },
          "required": ["auth", "p256dh"],
          "additionalProperties": false
        }
      },
      "additionalProperties": true
    },
    "device": {
      "type": "object",
      "properties": {
        "type": { "enum": ["browser", "native"] },
        "lang": { "type": "string", "minLength": 1 },
        "name": { "type": "string", "minLength": 1 },
        "os": { "type": "string", "minLength": 1 },
        "version": { "type": "string", "minLength": 1 },
        "uniqueId": { "type": "string", "minLength": 1 }
      },
      "required": ["type"],
      "additionalProperties": false
    }
  },
  "required": ["device"],
  "additionalProperties": false
}

HTTP status code 200

/device/delete/{id} post

post

/application

/application/about get

get

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  id: 'rm23gsa',
  created: '2016-05-27T17:07:16.000Z',
  name: 'The Best Application',
  type: 'application',
  callbackUri: [
    'https://example.com/callback',
    'https://example.net/other/callback'
  ]
}

/application/list get

get

/application/{id}/about get

get

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  id: 'rm23gsa',
  created: '2016-05-27T17:07:16.000Z',
  name: 'The Best Application',
  type: 'application',
  callbackUri: [
    'https://example.com/callback',
    'https://example.net/other/callback'
  ]
}

/application/{id}/secret get

get

/application/new post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "name": { "type": "string" },
    "callbackUri": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "required": ["name", "callbackUri"],
  "additionalProperties": false
}

HTTP status code 201

Body

Type: application/json

Example:

{
  id: 'rm23gsa'
}

/application/{id}/patch post

post

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "name": { "type": "string" },
    "callbackUri": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "additionalProperties": false
}

HTTP status code 200

Body

Type: application/json

Example:

{
  id: 'rm23gsa',
  created: '2016-05-27T17:07:16.000Z',
  name: 'The Best Application',
  type: 'application',
  callbackUri: [
    'https://example.com/callback',
    'https://example.net/other/callback'
  ]
}

/application/{id}/delete post

post

/application/{id}/restore post

post

/search

/search/trends get

get

/search/story get

get

/search/user get

get

/search/channel get

get

/search/modentry get

get

/search/suggestions get

get

/video

/video/key get

get

/video/publish post

post

/orphan

/orphan/complaint-form post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 60
    },
    "url": {
      "type": "string",
      "minLength": 3,
      "maxLength": 250
    },
    "email": {
      "type": "string",
      "minLength": 3,
      "maxLength": 250
    },
    "text": {
      "type": "string",
      "minLength": 3,
      "maxLength": 1024
    },
    "reason": { "type": "string" },
    "captcha": { "type": "string" }
  },
  "additionalProperties": false
}

HTTP status code 201

/orphan/resetpassword post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }, 
    "newUi": {
      "type": "boolean"
    }, 
    "captcha": { "type": "string" }
  },
  "required": ["id", "captcha"],
  "additionalProperties": false
}

HTTP status code 200

/orphan/changepassword post

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
     "username": {
      "type": "string",
      "minLength": 1
    },  
    "password": {
      "type": "string",
      "minLength": 6
    },
    "hash": {
      "type": "string",
      "minLength": 3,
      "maxLength": 1024
    },
    "captcha": { "type": "string" }
  },
  "additionalProperties": false
}

HTTP status code 200

/orphan/country/byip get

get

/chat

/chat/inbox get

Users chat inbox

get

/chat/room/new post

Create a chat room

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "type": { "type": "string", "enum": ["private"] },
    "members": {
      "type": "array",
      "uniqueItems": true,
      "maxItems": 1,
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 70
      }
    }
  },
  "required": ["members", "type"],
  "additionalProperties": false
}

HTTP status code 200

/chat/room/{roomId}/about get

fetch a chat room

get

/chat/room/{roomId}/send post

Send a message to chat room

post

Request
Response

URI Parameters

roomId: required (string)

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "body": {
      "type": "string"
    }
  },
  "required": ["body"],
  "additionalProperties": false
}

HTTP status code 200

/chat/room/{roomId}/read post

Flag message as read

post

/rewards

/rewards/balance get

Returns the balance if the user has a wallet, null otherwise

get

/rewards/balance/{username} get

Private | Returns the balance if the user has a wallet, null otherwise

get

/rewards/profile get

Returns the user profile including balance and current wallet

get

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  id: '1s6',
  created: '2019-08-21T19:25:33.565Z',
  type: 'user',
  tid: 29061915,
  username: 'JeffersonLic',
  firstname: 'Jefferson',
  lastname: 'Licet',
  birthday: '1970-01-01',
  avatar: 'https://a20.t26.net/taringa/avatares/8/B/F/A/3/9/JeffersonLic/120x120_413.jpg',
  background: null,
  site: '',
  gender: 'm',
  country: 'AR',
  message: '',
  wallpaper: '',
  wallpaperMode: 'cover',
  verified: false,
  deletedByUser: false,
  subscribedToDefaultChannels: true,
  stories: 93,
  followers: 1,
  following: 1,
  rank: 'Moderator',
  latestStory: '2020-05-07T13:58:34.450Z',
  comments: 20,
  balance: '60',
  email: '[email protected]',
  suscriptions: 5,
  alternateEmail: '[email protected]',
  wallet: {
    address: '0xf364098B2CD17900a0675c2F9B6f8936baD70F4f',
    guard: 'taringa',
    balance: '60'
  }
}

/rewards/activities get

Returns user activities

get

Request
Response

Query Parameters

page: (integer)
Page number
count: (integer)
Number of items to fetch
from: required (string)
Filters activities by source (me|others)
Example:
```
me
```
eventType: (string)
Filters activities by event type
Example:
```
story-visit
```
start: required (string)
Starting date to begin fetching activities, ISO 8601 format
end: required (string)
Ending date to stop fetching activities, ISO 8601 format
order: (string)
Sorting by creation date. ASC, DESC
Example:
```
DESC
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "count": 4,
  "page": 0,
  "items": [
    {
      "sourceUser": {
          "username": "JeffersonLic",
          "id": "1s6"
      },
      "targetUser": {
          "username": "cirkronos",
          "id": "1hjc"
      },
      "id": 49,
      "eventType": "story-voted",
      "targetObjectType": "story",
      "targetObjectId": "1hjj",
      "createdAt": "2020-05-07T14:00:03.000Z"
    },
    {
      "sourceUser": {
          "username": "JeffersonLic",
          "id": "1s6"
      },
      "targetUser": {
          "username": "cirkronos",
          "id": "1hjc"
      },
      "id": 50,
      "eventType": "story-voted",
      "targetObjectType": "story",
      "targetObjectId": "1hjj",
      "createdAt": "2020-05-07T14:00:04.000Z"
    },
    {
      "sourceUser": {
          "username": "JeffersonLic",
          "id": "1s6"
      },
      "targetUser": {
          "username": "cirkronos",
          "id": "1hjc"
      },
      "id": 51,
      "eventType": "story-visit",
      "targetObjectType": "story",
      "targetObjectId": "1hjj",
      "createdAt": "2020-05-07T14:00:06.000Z"
    },
    {
      "sourceUser": {
          "username": "JeffersonLic",
          "id": "1s6"
      },
      "targetUser": {
          "username": "cirkronos",
          "id": "1hjc"
      },
      "id": 52,
      "eventType": "comment-created",
      "targetObjectType": "story",
      "targetObjectId": "1hjj",
      "createdAt": "2020-05-07T14:00:10.000Z"
    }
  ]
}

/rewards/stats/all get

Private | Returns all stats

get

Request
Response

Query Parameters

start: required (string)
Starting date to begin fetching activities, ISO 8601 format
end: required (string)
Ending date to stop fetching activities, ISO 8601 format
order: (string)
Sorting by creation date. ASC, DESC
Example:
```
DESC
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "items": [
    {
      "userId": "2",
      "given": {
          "story-visit": 7
      },
      "received": {
          "story-voted": 1
      },
      "fixed": {
          "external-milestone-completed": "10"
      }
    },
    {
      "userId": "202",
      "given": {},
      "received": {
          "story-visit": 2,
          "story-voted": 1
      },
      "fixed": {}
    },
    {
      "userId": "210",
      "given": {},
      "received": {
          "story-visit": 1
      },
      "fixed": {}
    }
  ]
}

/rewards/stats get

Returns the user stats

get

Request
Response

Query Parameters

from: required (string)
Filters activities by source (me|others)
Example:
```
me
```
start: required (string)
Starting date to begin fetching activities, ISO 8601 format
end: required (string)
Ending date to stop fetching activities, ISO 8601 format

HTTP status code 200

Body

Type: application/json

Example:

{
  "items": {
    "comment-created": 1,
    "story-visit": 1,
    "story-voted": 2
  },
  "all": {
    "comment-created": 1,
    "story-visit": 1,
    "story-voted": 2
  }
}

/rewards/transactions get

Returns the user transactions

get

Request
Response

Query Parameters

page: (integer)
Page number
count: (integer)
Number of items to fetch
type: (string)
Filters transactions type (all|payment|spend)
start: required (string)
Starting date to begin fetching activities, ISO 8601 format
end: required (string)
Ending date to stop fetching activities, ISO 8601 format
order: (string)
Sorting by creation date. ASC, DESC
Example:
```
DESC
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "count": 2,
  "page": 0,
  "items": [
    {
      "transactionType": "payment",
      "amount": "200",
      "createdAt": "2020-05-13T17:51:29.000Z",
      "startDate": "2010-09-11",
      "endDate": "2011-09-11"
    },
    {
      "transactionType": "spend",
      "amount": "200",
      "createdAt": "2020-05-13T17:51:29.000Z",
      "metadata": {},
      "status": "successful"
    }
  ]
}

/rewards/transactions/summary get

Returns transactions summary

get

Request
Response

Query Parameters

start: required (string)
Starting date to begin fetching transactions, ISO 8601 format
end: required (string)
Ending date to stop fetching transactions, ISO 8601 format

HTTP status code 200

Body

Type: application/json

Example:

{
  "incoming": "200",
  "outgoing: "3535",
}

/rewards/payments/register post

Private | Register a collection of payments

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "array",
  "items": {
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "userId": {
        "type": "string"
      },
      "startDate": {
        "type": "string"
      },
      "endDate": {
        "type": "string"
      },
      "total": {
        "type": "string"
      },
      "items": {
        "type": "array"
      }
    },
    "required": ["userId", "startDate", "endDate", "total", "items"],
    "additionalProperties": false
  }
}

Example:

[
  {
    "userId": 1,
    "startDate": "2020-04-01",
    "endDate": "2020-04-30",
    "total": 60,
    "items": [
      {
        "eventType": "story-visit",
        "amount": 40
      },
      {
        "eventType": "story-created",
        "amount": 20
      }
    ]
  }
]

HTTP status code 200

Body

Type: application/json

/rewards/transaction/create post

Starts a new transaction

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "address": {
      "type": "string"
    },
    "amount": {
      "type": "string"
    },
    "metadata": {
      "type": "object"
    }
  },
  "required": ["address", "amount"],
  "additionalProperties": false
}

Example:

{
  "address": "0x1234535363636353",
  "amount": "50",
  "metadata": { "discountID": "1" },
}

HTTP status code 200

Body

Type: application/json

Example:

{
  value: '50',
  data: '0xa9059cbb0000000000000000000000002fd84f022f94b23ef3a203a86e3090084ed0d56c00000000000000000000000000000000000000000000000000005af3107a4000',
  nonce: 71,
  gasPrice: '118480000',
  gas: 38154,
  chainId: 31,
  transactionId: 1
}

/rewards/transaction/send post

Execute a signed transaction

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "hash": {
      "type": "string"
    },
    "transactionId": {
      "type": "number"
    }
  },
  "required": ["hash", "transactionId"],
  "additionalProperties": false
}

Example:

{
  "address": "0x1234535363636353",
  "amount": "50",
  "metadata": { "discountID": "1" },
}

HTTP status code 200

Body

Type: application/json

Example:

{
  hash: '0xa9059cbb0000000000',
}

/rewards/register/{username} post

Private | Add user to the program

post

/rewards/unregister/{username} post

Private | Remove user from the program

post

/rewards/wallet post

Create a wallet

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "address": {
      "type": "string"
    }
  },
  "required": ["address"],
  "additionalProperties": false
}

Example:

{
  "address": "0x1234535363636353",
}

HTTP status code 200

Body

Type: application/json

Example:

{
  "balance": '0',
  "address": '0x1234535363636353',
}

/rewards/wallet/{username} post

Private | Assign a wallet to a user

post

/rewards/event/register post

Private | Register a custom event

post

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      },
      "required": ["id", "username"],
      "additionalProperties": false
    },
    "amount": {
      "type": "string"
    },
    "created": {
      "type": "string"
    },
    "challengeId": {
      "type": "string"
    },
    "metadata": {
      "type": "object"
    }
  },
  "required": ["user", "amount", "challengeId"],
  "additionalProperties": false
}

Example:

{
  "user": {
    id: "1",
    username: "foo",
  },
  "amount": "100",
  "challengeId": "2",
  "metadata": {},
}

HTTP status code 200

Body

Type: application/json

/rewards/pool get

Private | Fetch pool allocation

get

/gifs

/gifs/search get

get

/authentication

/authentication/user/signup/local post

post

Request
Response

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "username": {
        "type": "string",
        "minLength": 1
      },
      "firstname": { "type": "string" },
      "lastname": { "type": "string" },
      "country": { "type": "string" },
      "email": { "type": "string" },
      "password": { "type": "string" }
    },
    "required": ["username", "email", "password"],
    "additionalProperties": false
  }

HTTP status code 201

/authentication/user/signup/facebook post

post

Request
Response

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "username": {
        "type": "string",
        "minLength": 1
      },
      "firstname": { "type": "string" },
      "id": { "type": "string" },
      "lastname": { "type": "string" },
      "country": { "type": "string" },
      "email": { "type": "string" },
      "birthday": { "type": "string" },
      "picture": { "type": "string" },
      "gender": { "type": "string" }
    },
    "required": ["username", "email"],
    "additionalProperties": false
  }

HTTP status code 201

/authentication/user/signup/google post

post

Request
Response

Body

Type: application/json

Schema:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties": {
      "username": {
        "type": "string",
        "minLength": 1
      },
      "firstname": { "type": "string" },
      "id": { "type": "string" },
      "lastname": { "type": "string" },
      "country": { "type": "string" },
      "email": { "type": "string" },
      "picture": { "type": "string" }
    },
    "required": ["username", "email"],
    "additionalProperties": false
  }

HTTP status code 201

/authentication/user/login/local post

post

/authentication/user/login/social post

post

/trends

/trends/list get

get

/trends/list/all get

get

/trends/new post

post

Request
Response

Body

Type: application/json

Schema:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "title": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "channelName": {
      "type": "string"
    }
  },
  "required": [
    "title",
    "url",
    "channelName"
  ],
  "additionalProperties": false
}

HTTP status code 201

/trends/delete post

post

Taringa! Brainiac API documentation

/auth

get /auth/login

Query Parameters

HTTP status code 302

get /auth/callback

Query Parameters

HTTP status code 302

get /auth/register

Query Parameters

HTTP status code 302

post /auth/logout

HTTP status code 200

post /auth/facebook/token

HTTP status code 200

Body

post /auth/google/authcode

HTTP status code 200

post /auth/signup/complete

HTTP status code 201

/oauth/v2

post /oauth/v2/token

HTTP status code 200

/user

get /user/tops

Query Parameters

HTTP status code 200

get /user/username/{username}

URI Parameters

HTTP status code 200

get /user/tid/{tid}

URI Parameters

HTTP status code 200

get /user/id/{id}

URI Parameters

HTTP status code 200

get /user/about

HTTP status code 200

Body

get /user/{username}/about

URI Parameters

HTTP status code 200

Body

post /user/new

Body

HTTP status code 201

post /user/patch

Body

HTTP status code 200

Body

post /user/{username}/moderate

URI Parameters

Body

HTTP status code 200

Body

post /user/settings/firstsession/patch

Body

HTTP status code 200

Body

post /user/settings/skipTutorial/patch

Body

HTTP status code 200

Body

post /user/settings/siteNotifications/patch

Body

HTTP status code 200

Body

post /user/settings/enableVideoAutoplay/patch

Body

HTTP status code 200

Body

post /user/settings/enableBetaTesting/patch

Body

HTTP status code 200

Body

post /user/settings/lang/patch

Body

HTTP status code 200

Body

post /user/settings/ntf/{device}/patch