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

/oauth/v2

/oauth/v2/token post

post

/user

/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)

Query Parameters

migrateClassic: (boolean)
updateClassic: (boolean)

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": {
    "tid": { "type": "number" },
    "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" }
  },
  "required": ["tid", "username"],
  "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" },
    "email": { "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/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"
        ] }
      ]
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    }
  },
  "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"
        ] }
      ]
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    }
  },
  "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"
        ] }
      ]
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    }
  },
  "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"
        ] }
      ]
    },
    "nsfw": {
      "type": "boolean"
    },
    "push": {
      "type": "boolean"
    }
  },
  "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" },
    "email": { "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/{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)
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}/comments/deleted get

get

/user/{username}/channels/deleted get

get

/user/{username}/changelog get

get

/user/blocks/list get

get

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

/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/{id} get

get

Request
Response

URI Parameters

id: required (string)

Query Parameters

updateClassic: (boolean)

HTTP status code 200

Body

Type: application/json

Example:

{
  type: 'gallery',
  images: [
    { url: expect_.url },
  ],
}

/story/_random get

get

/story/{id}/summary get

get

/story/{id}/related get

get

/story/{id}/related/global get

get

/story/{id}/comments 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" },
    "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 }
            },
            "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

/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

/c

/c/{name}/about get

get

/c/{name}/changelog get

get

/c/{name}/feed 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" },
    "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 }
            },
            "required": ["type", "url"],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "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" },
    "background": { "type": "string" },
    "description": { "type": "string" },
    "rules": { "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"] },
    "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/favorites get

get

/c/{name}/favorite/add post

post

/c/{name}/favorite/delete post

post

/c/{name}/seen post

post

/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

/feed

/feed/ get

get

/feed/global get

get

/feed/global/tops/{period} get

get

/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/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": {
    "username": {
      "type": "string",
      "minLength": 1
    },
    "captcha": { "type": "string" }
  },
  "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

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

/oauth/v2

post /oauth/v2/token

HTTP status code 200

/user

get /user/about

HTTP status code 200

Body

get /user/{username}/about

URI Parameters

Query 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/settings/firstsession/patch

Body

HTTP status code 200

Body

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

URI Parameters

Body

HTTP status code 200

Body

get /user/settings

HTTP status code 200

Body

post /user/settings/nsfw/patch

Body

HTTP status code 200

Body

post /user/settings/push/patch

Body

HTTP status code 200

Body

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

URI Parameters

HTTP status code 200

get /user/preferences

HTTP status code 200

Body

get /user/notifications

Query Parameters

HTTP status code 200

get /user/notifications/notseen

HTTP status code 200

post /user/notifications/{ntfId}/read

URI Parameters

HTTP status code 200

post /user/notifications/{ntfId}/unread

URI Parameters

HTTP status code 200

post /user/notifications/{ntfId}/delete

URI Parameters

HTTP status code 200

post /user/notifications/seen

HTTP status code 200

post /user/notifications/read