openapi: 3.0.3
info:
title: Inthegame API
version: 1.0.0
description: 'Interactive in-stream overlay and viewer-engagement platform API for OTT/CTV. Two surfaces:
adminApi (broadcaster/admin management of streamers, polls, trivia, ratings, wikis, shop, sponsors,
prizes, analytics) and userApi (end-viewer play: register/login, answer polls/trivia/ratings, chat,
leaderboard, shop). Converted from the provider-published Postman collection "Inthegame API Docs".'
contact:
name: Inthegame Support
email: support@inthegame.io
url: https://www.inthegame.io/
servers:
- url: https://api-dev.inthegame.io
description: Published API host (from Postman collection)
tags:
- name: admin
- name: streamer
- name: promotion
- name: analytics
- name: entity
- name: item
- name: moderationData
- name: poll
- name: category
- name: rating
- name: shop
- name: sponsor
- name: translations
- name: trivia
- name: uploads
- name: user
- name: wiki
- name: general
- name: leaderboard
- name: chat
- name: socket
components:
securitySchemes:
AdminToken:
type: apiKey
in: header
name: Authorization
description: Admin API token issued after login to the admin panel (https://admintest.inthegame.io/);
sent in the Authorization header.
paths:
/admin/currentUser:
get:
operationId: adminapiAdminGetcurrentuser
summary: GetCurrentUser
tags:
- admin
description: Gets current logged user object by token saved in cookies. Requested every time page
loads for applying some actions on server.
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
name: api_tester
password: 5d93ceb70e2bf5daa84ec3d0cd2c731a
email: leonid.arenshteyn@inthegame.io
broadcaster_name: api_tester
type: moderator
_id:
$id: 5fbce6c58703d05e5a73b6f4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/analytics/getParameters:
get:
operationId: adminapiAnalyticsGetparameters
summary: GetParameters
tags:
- analytics
description: Get help data for drop down in filter
parameters:
- name: per-page
in: query
required: false
schema:
type: string
example: '10000'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
devices:
- deviceName: Android
- deviceName: iPhone
- deviceName: iPad
- deviceName: BlackBerry
platforms:
- platformName: mobile
- platformName: web
countries:
- countryCode: US
countryName: United States
- countryCode: IL
countryName: Israel
browsers:
- browserName: Chrome
- browserName: Safari
- browserName: Firefox
- browserName: MSIE
type: new
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/analytics/getReport:
get:
operationId: adminapiAnalyticsGetreport
summary: GetReport
tags:
- analytics
description: Get report for analytics user actions from client (activities)
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
report:
- module: Rating
impressions: 2
engagements: 0
engagementRatio: 0
clicks: 0
ctr: 0
subModules:
- module: Harry Potter
impressions: 2
engagements: 0
ctr: 0
clicks: 0
engagementRatio: 0
- module: Polls
impressions: 2
engagements: 0
engagementRatio: 0
clicks: 0
ctr: 0
subModules:
- module: Test poll
impressions: 2
engagements: 0
ctr: 0
clicks: 0
engagementRatio: 0
- module: Quiz
impressions: 1
engagements: 0
engagementRatio: 0
clicks: 0
ctr: 0
subModules:
- module: Which year Harry Potter was born?
impressions: 1
engagements: 0
ctr: 0
clicks: 0
engagementRatio: 0
- module: Wiki
impressions: 5
engagements: 0
engagementRatio: 0
clicks: 0
ctr: 0
subModules:
- module: Test Wiki
impressions: 5
engagements: 0
ctr: 0
clicks: 0
engagementRatio: 0
- module: Chat
impressions: 1
engagements: 1
engagementRatio: 1
clicks: 0
ctr: 0
subModules: []
- module: Account
impressions: 1
engagements: 1
engagementRatio: 1
clicks: 0
ctr: 0
subModules: []
type: new
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/entity/create:
post:
operationId: adminapiEntityCreate
summary: Create
tags:
- entity
description: Send new entity object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
thumbnail:
type: string
example:
name: Test Entity
thumbnail: ''
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
entity:
name: Test Entity
user_id: 5fbce6c58703d05e5a73b6f4
thumbnail: ''
_id:
$id: 5fbd14d40174d8346b7cceb4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/entity/delete/{id}:
post:
operationId: adminapiEntityDelete
summary: Delete
tags:
- entity
description: Send entity id to delete it from db
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/entity/getAll:
get:
operationId: adminapiEntityGetall
summary: GetAll
tags:
- entity
description: Return entities list to admin panel
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
entities:
- name: Test entity
user_id: 5fbce6c58703d05e5a73b6f4
thumbnail: ''
_id:
$id: 5fbcf1b14ad5926a962b7f97
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/entity/getById/{id}:
get:
operationId: adminapiEntityGetbyid
summary: GetById
tags:
- entity
description: Return entity object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
entity:
name: Test entity
user_id: 5fbce6c58703d05e5a73b6f4
thumbnail: ''
_id:
$id: 5fbcf1b14ad5926a962b7f97
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/entity/update/{id}:
post:
operationId: adminapiEntityUpdate
summary: Update
tags:
- entity
description: Send entity object to update in db with given id and return updated entity
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
user_id:
type: string
thumbnail:
type: string
_id:
type: string
example:
name: Test Entity
user_id: 5fbce6c58703d05e5a73b6f4
thumbnail: ''
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
entity:
name: Test Entity
user_id: 5fbce6c58703d05e5a73b6f4
thumbnail: ''
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/create:
post:
operationId: adminapiItemCreate
summary: Create
tags:
- item
description: Send new item object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
alias:
type: string
status:
type: string
category:
type: string
type:
type: string
image:
type: string
shortcut:
type: string
item_order:
type: string
game_id:
type: string
game:
type: string
example:
name: Test
alias: ''
status: active
category: ''
type: thumbnail
image: '0'
shortcut: Test
item_order: '1'
game_id: 5fbceda5636497107a1cbdf3
game: Test category
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
item:
user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Test
shortcut: Test
item_order: 1
status: active
type: thumbnail
game_id: 5fbceda5636497107a1cbdf3
thumbnail: ''
_id:
$id: 5fbd171198ffc537f676f555
id: 5fbd171198ffc537f676f555
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/delete/{id}:
get:
operationId: adminapiItemDelete
summary: Delete
tags:
- item
description: Send item id to delete it from db
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/getAll:
get:
operationId: adminapiItemGetall
summary: GetAll
tags:
- item
description: Send request to get items list by filter options
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
items:
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: zombie
shortcut: zombie
item_order: 1
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage1123.png
_id:
$id: 5fbcee5aa759e61e0f7b0b87
pagination:
total: 1
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/getById/{id}:
get:
operationId: adminapiItemGetbyid
summary: GetById
tags:
- item
description: Return item object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
item:
user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: zombie
shortcut: zombie
item_order: 1
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage1123.png
_id:
$id: 5fbcee5aa759e61e0f7b0b87
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/importDefaultAvatars:
post:
operationId: adminapiItemImportdefaultavatars
summary: ImportDefaultAvatars
tags:
- item
description: Return status success if default avatrs imported in db
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
added: success
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/items/update/{id}:
post:
operationId: adminapiItemUpdate
summary: Update
tags:
- item
description: Send item object to update in db with given id and return updated item
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
user_id:
type: string
broadcaster_name:
type: string
name:
type: string
shortcut:
type: string
item_order:
type: string
status:
type: string
type:
type: string
game_id:
type: string
thumbnail:
type: string
_id:
type: string
example:
user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Test
shortcut: Test
item_order: '1'
status: active
type: thumbnail
game_id: 5fbceda5636497107a1cbdf3
thumbnail: ''
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
item:
user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Test
shortcut: Test
item_order: 1
status: active
type: thumbnail
game_id: 5fbceda5636497107a1cbdf3
thumbnail: ''
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/league/create_new:
post:
operationId: ratingCategoryCreate
summary: Create
tags:
- category
description: Send new category object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
shortcut:
type: string
status:
type: string
image:
type: string
example:
name: New Category
shortcut: new
status: active
image: ''
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
league:
name: New Category
shortcut: new
status: active
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id:
$id: 5fbd1bb85424bf3aaf679678
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/league/delete_new/{id}:
post:
operationId: ratingCategoryDelete
summary: Delete
tags:
- category
description: Send category id to delete it from db
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/league/getActive_New:
get:
operationId: ratingCategoryGetactivecategories
summary: GetActiveCategories
tags:
- category
description: Send request to get categories list by filter options
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
leagues:
- name: Test category
shortcut: test
status: active
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id:
$id: 5fbceda5636497107a1cbdf3
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/league/getById_New/{id}:
get:
operationId: ratingCategoryGetbyid
summary: GetById
tags:
- category
description: Return category object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
league:
name: Test category
shortcut: test
status: active
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id:
$id: 5fbceda5636497107a1cbdf3
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/league/update_new/{id}:
post:
operationId: ratingCategoryUpdate
summary: Update
tags:
- category
description: Send category object to update in db with given id and return updated category
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
shortcut:
type: string
status:
type: string
user_id:
type: string
image:
type: string
_id:
type: string
example:
name: New Category
shortcut: new
status: active
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
league:
name: New Category
shortcut: new
status: active
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/moderatorData/getModeratorDataByUserIdOrCreate/{user_id}:
get:
operationId: adminapiModerationdataGetbyuseridorcreate
summary: GetByUserIdOrCreate
tags:
- moderationData
description: Get broadcaster settings moderation data by user id or create it if it doesn't exist
in db
parameters:
- name: user_id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
moderatorData:
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList: ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
_id:
$id: 5fbcf1b4a759e61e0f7b0bc4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/moderatorData/getModeratorDataCurrentUser:
get:
operationId: adminapiModerationdataGetbycurrentuser
summary: GetByCurrentUser
tags:
- moderationData
description: Return moderation data of current broadcaster
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
moderatorData:
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList: ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
_id:
$id: 5fbcf1b4a759e61e0f7b0bc4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/moderatorData/update/{dataId}:
post:
operationId: adminapiModerationdataUpdate
summary: Update
tags:
- moderationData
description: Send moderation data object to update in db with given id and return updated data
parameters:
- name: dataId
in: path
required: true
schema:
type: string
responses:
'200':
description: Default
content:
text/plain:
schema:
type: string
example: '{"moderatorData":{*****}}'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/create:
post:
operationId: adminapiPollCreate
summary: Create
tags:
- poll
description: Send new poll object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
type:
type: string
viewType:
type: string
question:
type: string
hideButtons:
type: string
answers:
type: string
expoints:
type: string
questionType:
type: string
example:
name: Cinema
type: streamer
viewType: percentage
question: Best Film ever
hideButtons: '0'
answers: '[object Object],[object Object],[object Object],[object Object],[object Object],[object
Object]'
expoints: '150'
questionType: poll
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
poll:
name: Cinema
type: streamer
items: []
time_limit: 0
user_id: 5fbce6c58703d05e5a73b6f4
questionType: poll
viewType: percentage
question: Best Film ever
image: ''
hideButtons: 0
answers:
- answer: Avatar
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: LOTR
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Inception
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Avengers 4
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Titanic
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Dark Knight
image: ''
reward: 0
isRewardSent: false
answerSending: false
expoints: '150'
_id:
$id: 5fbd1fc904e3c324c21aed48
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/delete/{pollId}:
post:
operationId: adminapiPollDelete
summary: Delete
tags:
- poll
description: Send poll id to delete it from db
parameters:
- name: pollId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/getAll:
get:
operationId: adminapiPollGetall
summary: GetAll
tags:
- poll
description: Send request to get polls list by filter options
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
polls:
- name: New Poll
type: streamer
items:
- id: 5fbcee2e636497107a1cbdf4
name: test_channel
time_limit: 0
user_id: 5fbce6c58703d05e5a73b6f4
questionType: poll
viewType: percentage
question: Test?
image: ''
hideButtons: 0
answers:
- answer: Test
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Live
image: ''
reward: 0
isRewardSent: false
answerSending: false
expoints: '20'
_id:
$id: 5fbd07fc48196740b75d323b
pagination:
total: 1
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/getById{pollId}:
get:
operationId: adminapiPollGetbyid
summary: GetById
tags:
- poll
description: Return poll object selected by given id
parameters:
- name: pollId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
poll:
name: New Poll
type: streamer
items:
- id: 5fbcee2e636497107a1cbdf4
name: test_channel
time_limit: 0
user_id: 5fbce6c58703d05e5a73b6f4
questionType: poll
viewType: percentage
question: Test?
image: ''
hideButtons: 0
answers:
- answer: Test
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Live
image: ''
reward: 0
isRewardSent: false
answerSending: false
expoints: '20'
_id:
$id: 5fbd07fc48196740b75d323b
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/result/{pollId}:
post:
operationId: adminapiPollSendwinresult
summary: SendWinResult
tags:
- poll
description: Send request for sending win result of given poll answer to whole users in client
parameters:
- name: pollId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
answer:
type: string
image:
type: string
reward:
type: string
isRewardSent:
type: string
answerSending:
type: string
example:
answer: '2050'
image: ''
reward: '500'
isRewardSent: 'false'
answerSending: 'false'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
pollAnswers:
- answer: '2050'
image: ''
reward: '500'
isRewardSent: true
answerSending: true
- answer: '2070'
image: ''
reward: '900'
isRewardSent: false
answerSending: false
- answer: '2100'
image: ''
reward: '100'
isRewardSent: false
answerSending: false
- answer: Never
image: ''
reward: '400'
isRewardSent: false
answerSending: false
winners: 0
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/poll/update/{pollId}:
post:
operationId: adminapiPollUpdate
summary: Update
tags:
- poll
description: Send poll object to update in db with given id and return updated poll
parameters:
- name: pollId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
type:
type: string
items:
type: string
time_limit:
type: string
user_id:
type: string
questionType:
type: string
viewType:
type: string
question:
type: string
image:
type: string
hideButtons:
type: string
answers:
type: string
expoints:
type: string
_id:
type: string
example:
name: Cinema
type: streamer
items: ''
time_limit: '0'
user_id: 5fbce6c58703d05e5a73b6f4
questionType: poll
viewType: percentage
question: Best Film ever
image: ''
hideButtons: '0'
answers: '[object Object],[object Object],[object Object],[object Object],[object Object],[object
Object]'
expoints: '150'
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
poll:
name: Cinema
type: streamer
items: []
time_limit: 0
questionType: poll
viewType: percentage
question: Best Film ever
image: ''
hideButtons: 0
answers:
- answer: Avatar
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: LOTR
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Inception
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Avengers 4
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Titanic
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Dark Knight
image: ''
reward: 0
isRewardSent: false
answerSending: false
expoints: '150'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/prize/create:
post:
operationId: adminapiPromotionCreate
summary: Create
tags:
- promotion
description: Send new promotion object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
url:
type: string
streamers:
type: string
type:
type: string
itemType:
type: string
viewType:
type: string
secondsDelay:
type: string
items:
type: string
content:
type: string
sponsor:
type: string
offersOptions:
type: string
meta:
type: string
example:
name: Ads
description: test
url: ''
streamers: ''
type: ''
itemType: ''
viewType: ''
secondsDelay: '0'
items: ''
content: Wow
sponsor: 5fbcee9ce1a5930b1508c482
offersOptions: '[object Object]'
meta: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
prize:
name: Ads
place: ''
streamers: []
description: test
url: ''
thumbnail: ''
itemType: null
items: []
content: 'Wow
'
sponsor: 5fbcee9ce1a5930b1508c482
type: null
viewType: []
secondsDelay: 0
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: false
chatMessage: ''
interval: 0
meta:
left: 0
top: 0
width: 0
height: 0
expoints: 0
_id:
$id: 5fbd0f4baec04b6e69438292
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/prize/delete/{prizeId}:
post:
operationId: adminapiPromotionDelete
summary: Delete
tags:
- promotion
description: Send promotion id to delete it from db
parameters:
- name: prizeId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/prize/getAll:
get:
operationId: adminapiPromotionGetall
summary: GetAll
tags:
- promotion
description: Send request to get promotions list
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
prizes:
- name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
lastSentTime: 1606225889
_id:
$id: 5fbcef0cf2d31b5bc07df5cc
- name: Test promo
place: ''
streamers: []
description: test
url: ''
thumbnail: ''
itemType: null
items: []
content: 'Test promo
'
sponsor: 5fbcee9ce1a5930b1508c482
type: null
viewType: []
secondsDelay: 0
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: false
chatMessage: ''
interval: 0
meta:
left: 0
top: 0
width: 0
height: 0
expoints: '10'
_id:
$id: 5fbd0f2898ffc537f676f529
- name: Ads
place: ''
streamers: []
description: test
url: ''
thumbnail: ''
itemType: null
items: []
content: 'Wow
'
sponsor: 5fbcee9ce1a5930b1508c482
type: null
viewType: []
secondsDelay: 0
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: false
chatMessage: ''
interval: 0
meta:
left: 0
top: 0
width: 0
height: 0
expoints: 0
_id:
$id: 5fbd0f4baec04b6e69438292
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/prize/getById/{id}:
get:
operationId: adminapiPromotionGetbyid
summary: GetById
tags:
- promotion
description: Return promotion object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
prize:
name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
lastSentTime: 1606225889
_id:
$id: 5fbcef0cf2d31b5bc07df5cc
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/prize/update/{prizeId}:
post:
operationId: adminapiPromotionUpdate
summary: Update
tags:
- promotion
description: Send promotion object to update in db with given id and return updated promotion
parameters:
- name: prizeId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
place:
type: string
streamers:
type: string
description:
type: string
url:
type: string
thumbnail:
type: string
itemType:
type: string
items:
type: string
content:
type: string
sponsor:
type: string
type:
type: string
viewType:
type: string
secondsDelay:
type: string
user_id:
type: string
offersOptions:
type: string
meta:
type: string
lastSentTime:
type: string
_id:
type: string
example:
name: test promo
place: ''
streamers: '[object Object]'
description: test
url: test.com
thumbnail: ''
itemType: big
items: ''
content: Welcome to my channel
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType: flip
secondsDelay: '5'
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions: '[object Object]'
meta: '[object Object]'
lastSentTime: '1606225889'
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
prize:
name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
sponsorLogo: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/rating/create:
post:
operationId: adminapiRatingCreate
summary: Create
tags:
- rating
description: Send new rating object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
icon:
type: string
optionsNumber:
type: string
streamers:
type: string
expoints:
type: string
example:
name: New Rating
description: Test
icon: ''
optionsNumber: '3'
streamers: ''
expoints: '25'
responses:
'200':
description: Api Test
content:
application/json:
schema:
type: object
example:
rating:
name: New Rating
description: Test
optionsNumber: '3'
user_id: 5fbce6c58703d05e5a73b6f4
icon: ''
streamers: []
expoints: '25'
_id:
$id: 5fbf89dfb4f1c0219d147841
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/rating/delete/{ratingId}:
post:
operationId: adminapiRatingDelete
summary: Delete
tags:
- rating
description: Send rating id to delete it from db
parameters:
- name: ratingId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/rating/getAll:
get:
operationId: adminapiRatingGetall
summary: GetAll
tags:
- rating
description: Send request to get ratings list by filter options
responses:
'200':
description: Default
content:
text/plain:
schema:
type: string
example: '{"ratings":[****],"pagination":{"total":0,"currentPage":"1","totalPages":0}}'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/rating/getById/{ratingId}:
get:
operationId: adminapiRatingGetbyid
summary: GetById
tags:
- rating
description: Return rating object selected by given id
parameters:
- name: ratingId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
rating:
name: Harry Potter
description: film
optionsNumber: '5'
user_id: 5fbce6c58703d05e5a73b6f4
icon: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
expoints: '80'
_id:
$id: 5fbcf1325e784e3816715935
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/rating/update/{ratingId}:
post:
operationId: adminapiRatingUpdate
summary: Update
tags:
- rating
description: Send rating object to update in db with given id and return updated rating
parameters:
- name: ratingId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
optionsNumber:
type: string
user_id:
type: string
icon:
type: string
streamers:
type: string
expoints:
type: string
_id:
type: string
meta:
type: string
example:
name: New Rating
description: Test
optionsNumber: '3'
user_id: 5fbce6c58703d05e5a73b6f4
icon: ''
streamers: ''
expoints: '25'
_id: '[object Object]'
meta: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
rating:
name: New Rating
description: Test
optionsNumber: '3'
icon: ''
streamers: []
expoints: '25'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/shop/create:
post:
operationId: adminapiShopCreate
summary: Create
tags:
- shop
description: Send new shop object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
pointsXP:
type: string
image:
type: string
example:
name: New Item
description: test
pointsXP: '100'
image: '{binary}'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
shop:
name: New Item
description: test
pointsXP: '100'
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id:
$id: 5fbf8ba778c77731880d90c8
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/shop/delete/{id}:
post:
operationId: adminapiShopDelete
summary: Delete
tags:
- shop
description: Send shop id to delete it from db
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Default
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/shop/getAll:
get:
operationId: adminapiShopGetall
summary: GetAll
tags:
- shop
description: Send request to get shop items list
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
shop:
- name: test item
description: test
pointsXP: '100'
user_id: 5fbce6c58703d05e5a73b6f4
image: /uploads/shop/4c043d20a7673bcc1189956cef8edc63.ba46792ede92a2eec53f35d8fd4c49e7.png
_id:
$id: 5fbcee8ae6cc2a181c6d5422
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/shop/getById/{id}:
get:
operationId: adminapiShopGetbyid
summary: GetById
tags:
- shop
description: Return shop object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Default
content:
application/json:
schema:
type: object
example:
shop:
name: '***'
description: '***'
pointsXP: '***'
user_id: '***'
image: '***'
_id:
$id: '***'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/shop/update/{id}:
post:
operationId: adminapiShopUpdate
summary: Update
tags:
- shop
description: Send shop object to update in db with given id and return updated shop item
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
pointsXP:
type: string
user_id:
type: string
image:
type: string
_id:
type: string
example:
name: New Item
description: test
pointsXP: '100'
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
_id: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
shop:
name: New Item
description: test
pointsXP: '100'
user_id: 5fbce6c58703d05e5a73b6f4
image: ''
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/show/{language}/{key}:
get:
operationId: adminapiTranslationsShow
summary: Show
tags:
- translations
description: Get translation data for selected item
parameters:
- name: language
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
user_id: 5fbce6c58703d05e5a73b6f4
language: ru
key: poll-5fbcf049f2d31b5bc07df5ce
values:
name: Тестовый
question: Вам хорошо?
options:
- Да
- Нет
- Не очень
_id:
$id: 5fbfaa8cefd2bf3c6b5e7ae4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/sponsor/create:
post:
operationId: adminapiSponsorCreate
summary: Create
tags:
- sponsor
description: Send new sponsor object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
example:
name: Test
description: Test
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
sponsor:
login: ''
password: ''
name: Test
description: Test
url: ''
logo: ''
user_id: 5fbce6c58703d05e5a73b6f4
_id:
$id: 5fbfa823a943a01e1029b4a3
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/sponsor/delete/{id}:
post:
operationId: adminapiSponsorDelete
summary: Delete
tags:
- sponsor
description: Send sposnor id to delete it from db
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/sponsor/getAll:
get:
operationId: adminapiSponsorGetall
summary: GetAll
tags:
- sponsor
description: Send request to get sponsors list by filter options
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
sponsors:
- login: ''
password: ''
name: test sponsor
description: test
url: ''
logo: ''
user_id: 5fbce6c58703d05e5a73b6f4
_id:
$id: 5fbcee9ce1a5930b1508c482
pagination:
total: 1
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/sponsor/getById/{id}:
get:
operationId: adminapiSponsorGetbyid
summary: GetById
tags:
- sponsor
description: Return sponsor object selected by given id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
sponsor:
login: ''
password: ''
name: Test
description: Test
url: ''
logo: ''
user_id: 5fbce6c58703d05e5a73b6f4
_id:
$id: 5fbfa823a943a01e1029b4a3
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/sponsor/update/{sponsorId}:
post:
operationId: adminapiSponsorUpdate
summary: Update
tags:
- sponsor
description: Send sponsor object to update in db with given id and return updated sponsor
parameters:
- name: sponsorId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description:
type: string
example:
name: Test
description: Test
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
sponsor:
login: ''
password: ''
name: Test
description: Test
url: ''
logo: ''
user_id: 5fbce6c58703d05e5a73b6f4
_id:
$id: 5fbfa823a943a01e1029b4a3
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/addPollEngagement/{channelId}:
post:
operationId: adminapiStreamerAddpollengagement
summary: AddPollEngagement
tags:
- streamer
description: Request to engage poll to streamer
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
pollId:
type: string
time:
type: string
example:
pollId: 5fbd07fc48196740b75d323b
time: '25'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
poll:
id: 5fbd07fc48196740b75d323b
name: New Poll
question: Test?
questionType: poll
type: streamer
hideButtons: 0
image: ''
time_limit: 0
items:
- id: 5fbcee2e636497107a1cbdf4
name: test_channel
viewType: percentage
answers:
- answer: Test
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: Live
image: ''
reward: 0
isRewardSent: false
answerSending: false
answers_statistic: []
answers_total: 0
prizes: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/addTriviaEngagement/{channelId}/1:
post:
operationId: adminapiStreamerAddtriviaquestionengagement
summary: AddTriviaQuestionEngagement
tags:
- streamer
description: Request to engage trivia to streamer
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
triviaId:
type: string
time:
type: string
example:
triviaId: 5fbd096648196740b75d323c
time: '15'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
streamer:
name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: true
rating: true
rating_menu: true
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks:
- id: 5fbd060eaec04b6e6943828b
module: wiki
timeToStay: '10'
time: 0
simpleModule: null
- id: 5fbd07fc48196740b75d323b
module: polls
timeToStay: '10'
time: '25'
- id: 5fbd096648196740b75d323c
simpleModule: null
timeToStay: '10'
module: quiz
time: 15
streamSourceType: file
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
moderator_data:
- _id:
$oid: 5fbcf1b4a759e61e0f7b0bc4
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList:
- ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
_id:
$id: 5fbcee2e636497107a1cbdf4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/addWikiEngagement/{channelId}:
post:
operationId: adminapiStreamerAddwikiengagement
summary: AddWikiEngagement
tags:
- streamer
description: Request to engage wiki to streamer
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
wikiId:
type: string
time:
type: string
example:
wikiId: 5fbd09ff0174d8346b7cce86
time: '50'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
wiki:
id: 5fbd09ff0174d8346b7cce86
name: Whats Up
showInMenu: false
icon: ''
content: 'What's UP BRO?
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
meta:
left: 60px
top: 60px
width: 300px
height: 300px
expoints: '150'
type: html
tweetUrl: ''
prizes: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/create:
post:
operationId: adminapiStreamerCreate
summary: Create
tags:
- streamer
description: Send new streamer object to save and return it as db object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
useUrl:
type: string
channel_name:
type: string
channel_id:
type: string
pageUrl:
type: string
is_permanent:
type: string
is_featured:
type: string
status:
type: string
chat_url:
type: string
stream_url:
type: string
streamSourceType:
type: string
game:
type: string
game_id:
type: string
user_id:
type: string
position:
type: string
modules:
type: string
clocks:
type: string
moderators:
type: string
banList:
type: string
offersInterval:
type: string
chatDelay:
type: string
profanityList:
type: string
useCustomProfanity:
type: string
streamerLogo:
type: string
customCSS:
type: string
hide_on_smartphone_portrait_mode:
type: string
wikiList:
type: string
additionalInfo:
type: string
languagesList:
type: string
approvalMessageMode:
type: string
example:
name: Default Page
useUrl: 'false'
channel_name: new_page
channel_id: new_page
pageUrl: ''
is_permanent: '1'
is_featured: '0'
status: '1'
chat_url: ''
stream_url: ''
streamSourceType: ''
game: ''
game_id: ''
user_id: ''
position: '0'
modules: '[object Object]'
clocks: ''
moderators: ''
banList: ''
offersInterval: '0'
chatDelay: '0'
profanityList: ''
useCustomProfanity: 'false'
streamerLogo: ''
customCSS: ''
hide_on_smartphone_portrait_mode: 'true'
wikiList: ''
additionalInfo: '[object Object]'
languagesList: ''
approvalMessageMode: timer
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
streamer:
name: Default Page
useUrl: false
channel_name: new_page
channel_id: new_page
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: ''
chat_url: ''
registration_bonus: ''
game: ''
game_id: ''
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: false
chat_menu: false
wiki: false
rating: false
rating_menu: false
rating_icon: false
rating_icon_image: ''
retention: false
close: false
shop: true
shop_menu: true
clocks: []
streamSourceType: ''
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
_id:
$id: 5fbcf7a7ddbd2068304f33d6
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/delete/{streamerId}:
post:
operationId: adminapiStreamerDelete
summary: Delete
tags:
- streamer
description: Send streamer id to delete it from db
parameters:
- name: streamerId
in: path
required: true
schema:
type: string
responses:
'200':
description: APi Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/getAll:
get:
operationId: adminapiStreamerGetall
summary: GetAll
tags:
- streamer
description: Send request to get streamers list
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
streamers:
- name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: false
rating: false
rating_menu: false
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks: []
streamSourceType: file
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
_id:
$id: 5fbcee2e636497107a1cbdf4
pagination:
total: 1
currentPage: 1
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/getById/{streamerId}:
get:
operationId: adminapiStreamerGetbyid
summary: GetById
tags:
- streamer
description: Return streamer object selected by given id
parameters:
- name: streamerId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
streamer:
name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: false
rating: false
rating_menu: false
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks: []
streamSourceType: file
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList: ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
_id:
$id: 5fbcee2e636497107a1cbdf4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectModule/{channelId}:
post:
operationId: adminapiStreamerInjectmodule
summary: InjectModule
tags:
- streamer
description: Request to inject module
parameters:
- name: channelId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
moduleId: account
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectOffer/{channel_id}:
post:
operationId: adminapiStreamerInjectoffer
summary: InjectOffer
tags:
- streamer
description: Request to inject offer
parameters:
- name: channel_id
in: path
required: true
schema:
type: string
responses:
'200':
description: APi Test
content:
application/json:
schema:
type: object
example:
offer:
name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
lastSentTime: 1606222769
_id:
$id: 5fbcef0cf2d31b5bc07df5cc
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectPoll/{channelId}:
post:
operationId: adminapiStreamerInjectpoll
summary: InjectPoll
tags:
- streamer
description: Request to inject a poll or a prediction
parameters:
- name: channelId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
poll:
id: 5fbcf049f2d31b5bc07df5ce
name: Test poll
question: Filling good?
questionType: poll
type: streamer
hideButtons: 0
image: ''
time_limit: 0
items:
- id: 5fbcee2e636497107a1cbdf4
name: test_channel
viewType: numbers
answers:
- answer: 'Yes'
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: 'No'
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: So so
image: ''
reward: 0
isRewardSent: false
answerSending: false
answers_statistic: []
answers_total: 0
prizes: []
streamer:
name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: false
rating: false
rating_menu: false
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks: []
streamSourceType: file
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
moderator_data:
- _id:
$oid: 5fbcf1b4a759e61e0f7b0bc4
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList:
- ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
_id:
$id: 5fbcee2e636497107a1cbdf4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectRating/{channelId}:
post:
operationId: adminapiStreamerInjectrating
summary: InjectRating
tags:
- streamer
description: Request to inject rating
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
ratingId:
type: string
timeToStay:
type: string
closePostInteraction:
type: string
popOnChannel:
type: string
example:
ratingId: 5fbcf1325e784e3816715935
timeToStay: '10'
closePostInteraction: 'true'
popOnChannel: 'true'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
rating:
id: 5fbcf1325e784e3816715935
name: Harry Potter
description: film
icon: ''
optionsNumber: '5'
answers: []
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
prizes: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectTrivia/{channelId}:
post:
operationId: adminapiStreamerInjecttrivia
summary: InjectTrivia
tags:
- streamer
description: Request to inject trivia
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
questionId:
type: string
timeToStay:
type: string
closePostInteraction:
type: string
example:
questionId: 5fbcf1055e784e3816715934
timeToStay: '10'
closePostInteraction: 'true'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
status: true
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/injectWiki/{channelId}:
post:
operationId: adminapiStreamerInjectwiki
summary: InjectWiki
tags:
- streamer
description: Request to inject wiki
parameters:
- name: channelId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
wikiId:
type: string
timeToStay:
type: string
example:
wikiId: 5fbd060eaec04b6e6943828b
timeToStay: '10'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
wiki:
id: 5fbd060eaec04b6e6943828b
name: Test Wiki
showInMenu: false
icon: ''
content: 'Hello to all!!!
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
meta:
left: 250px
top: 50px
width: 150px
height: 150px
expoints: '10'
type: html
tweetUrl: ''
prizes: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/toggle/{streamerId}:
post:
operationId: adminapiStreamerToggleactivemode
summary: ToggleActiveMode
tags:
- streamer
description: Send streamer id to reflect active state
parameters:
- name: streamerId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/streamer/update:
post:
operationId: adminapiStreamerUpdate
summary: Update
tags:
- streamer
description: Send streamer object to update in db with given id and return updated streamer
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
useUrl:
type: string
channel_name:
type: string
channel_id:
type: string
broadcaster_id:
type: string
pageUrl:
type: string
additionalPageSettings:
type: string
stream_url:
type: string
chat_url:
type: string
registration_bonus:
type: string
game:
type: string
game_id:
type: string
is_permanent:
type: string
is_featured:
type: string
status:
type: string
modules:
type: string
clocks:
type: string
streamSourceType:
type: string
moderators:
type: string
banList:
type: string
offersInterval:
type: string
direction:
type: string
user_id:
type: string
chatDelay:
type: string
profanityList:
type: string
useCustomProfanity:
type: string
streamerLogo:
type: string
wikiList:
type: string
additionalInfo:
type: string
languagesList:
type: string
customCSS:
type: string
hide_on_smartphone_portrait_mode:
type: string
approvalMessageMode:
type: string
broadcasterUseBlocks:
type: string
_id:
type: string
position:
type: string
example:
name: Default Page
useUrl: 'false'
channel_name: new_page
channel_id: new_page
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: ''
chat_url: ''
registration_bonus: ''
game: ''
game_id: ''
is_permanent: '1'
is_featured: '0'
status: '1'
modules: '[object Object]'
clocks: ''
streamSourceType: ''
moderators: ''
banList: ''
offersInterval: '0'
direction: '0'
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: '0'
profanityList: ''
useCustomProfanity: 'false'
streamerLogo: ''
wikiList: ''
additionalInfo: '[object Object]'
languagesList: ''
customCSS: ''
hide_on_smartphone_portrait_mode: 'true'
approvalMessageMode: timer
broadcasterUseBlocks: '[object Object]'
_id: '[object Object]'
position: '0'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
streamer:
name: Default Page
useUrl: false
channel_name: new_page
channel_id: new_page
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: ''
chat_url: ''
registration_bonus: ''
game: ''
game_id: ''
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: false
chat_menu: false
wiki: false
rating: false
rating_menu: false
rating_icon: false
rating_icon_image: ''
retention: false
close: false
shop: true
shop_menu: true
clocks: []
streamSourceType: ''
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList: ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
_id:
$id: 5fbcf7a7ddbd2068304f33d6
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/translations/add/{key}/{language}:
post:
operationId: adminapiTranslationsAdd
summary: Add
tags:
- translations
description: Create translation item by generated key and language id
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: language
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
question:
type: string
options:
type: string
example:
name: Тестовый
question: Вам хорошо?
options: Да,Нет,Не очень
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
translation:
user_id: 5fbce6c58703d05e5a73b6f4
language: ru
key: poll-5fbcf049f2d31b5bc07df5ce
values:
name: Тестовый
question: Вам хорошо?
options:
- Да
- Нет
- Не очень
_id:
$id: 5fbfaa8cefd2bf3c6b5e7ae4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/translations/destroy/{language}/{key}:
post:
operationId: adminapiTranslationsDelete
summary: Delete
tags:
- translations
description: Delete selected translation item
parameters:
- name: language
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/translations/languagesList:
get:
operationId: adminapiTranslationsGetlanguageslist
summary: GetLanguagesList
tags:
- translations
description: Return language codes list
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
- he
- de
- ru
- ko
- jp
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/translations/list/{language}:
get:
operationId: adminapiTranslationsGetall
summary: GetAll
tags:
- translations
description: Get all translation for give language
parameters:
- name: language
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
- user_id: 5fbce6c58703d05e5a73b6f4
language: ru
key: poll-5fbcf049f2d31b5bc07df5ce
values:
name: Тестовый
question: Вам хорошо?
options:
- Да
- Нет
- Не очень
_id:
$id: 5fbfaa8cefd2bf3c6b5e7ae4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/translations/update/{key}/{language}:
post:
operationId: adminapiTranslationsUpdate
summary: Update
tags:
- translations
description: Update selected translation item
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: language
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
question:
type: string
options:
type: string
example:
name: Тестовый
question: Вам хорошо?
options: Да,Нет,Не очень
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
translation:
user_id: 5fbce6c58703d05e5a73b6f4
values:
name: Тестовый
question: Вам хорошо?
options:
- Да
- Нет
- Не очень
key: poll-5fbcf049f2d31b5bc07df5ce
language: ru
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/trivia/create:
post:
operationId: adminapiTriviaCreate
summary: Create
tags:
- trivia
description: Create trivia in db and return new object
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
type:
type: string
question:
type: string
category:
type: string
correctAnswer:
type: string
incorrectAnswers:
type: string
pointsGiven:
type: string
timePerQuestion:
type: string
expoints:
type: string
delayUntilAnswer:
type: string
example:
type: ''
question: Test
category: ''
correctAnswer: '123'
incorrectAnswers: '[object Object],[object Object],[object Object]'
pointsGiven: '50'
timePerQuestion: '50'
expoints: '100'
delayUntilAnswer: '10'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
trivia:
question: Test
pointsGiven: 50
timePerQuestion: 50
delayUntilAnswer: 10
category: ''
user_id: 5fbce6c58703d05e5a73b6f4
correctAnswer: '123'
expoints: '100'
incorrectAnswers:
- '321'
- '231'
- '132'
_id:
$id: 5fbfad2a7fc1bb4f5411a114
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/trivia/delete/{triviaId}:
post:
operationId: adminapiTriviaDelete
summary: Delete
tags:
- trivia
description: Remove selected trivia from db
parameters:
- name: triviaId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/trivia/getAll:
get:
operationId: adminapiTriviaGetall
summary: GetAll
tags:
- trivia
description: Return trivia list with filter options
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
trivias:
- question: What does admin want?
pointsGiven: 1500
timePerQuestion: 20
delayUntilAnswer: 0
category: ''
user_id: 5fbce6c58703d05e5a73b6f4
correctAnswer: Tambourine
expoints: '1500'
incorrectAnswers:
- Windows
- Cry
- Vacation
_id:
$id: 5fbd096648196740b75d323c
pagination:
total: 1
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/trivia/getById/{triviaId}:
get:
operationId: adminapiTriviaGetbyid
summary: GetById
tags:
- trivia
description: Return trivia by given id
parameters:
- name: triviaId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
trivia:
question: What does admin want?
pointsGiven: 1500
timePerQuestion: 20
delayUntilAnswer: 0
category: ''
user_id: 5fbce6c58703d05e5a73b6f4
correctAnswer: Tambourine
expoints: '1500'
incorrectAnswers:
- answer: Windows
- answer: Cry
- answer: Vacation
_id:
$id: 5fbd096648196740b75d323c
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/trivia/update/{triviaId}:
post:
operationId: adminapiTriviaUpdate
summary: Update
tags:
- trivia
description: Update trivia with given id
parameters:
- name: triviaId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
question:
type: string
pointsGiven:
type: string
timePerQuestion:
type: string
delayUntilAnswer:
type: string
category:
type: string
user_id:
type: string
correctAnswer:
type: string
expoints:
type: string
incorrectAnswers:
type: string
_id:
type: string
meta:
type: string
example:
question: Test
pointsGiven: '50'
timePerQuestion: '50'
delayUntilAnswer: '10'
category: ''
user_id: 5fbce6c58703d05e5a73b6f4
correctAnswer: '123'
expoints: '100'
incorrectAnswers: '[object Object],[object Object],[object Object]'
_id: '[object Object]'
meta: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
trivia:
question: Test
category: ''
pointsGiven: 50
timePerQuestion: 50
delayUntilAnswer: 10
correctAnswer: '123'
expoints: '100'
incorrectAnswers:
- '321'
- '231'
- '132'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/user/getAll:
get:
operationId: adminapiUserGetall
summary: GetAll
tags:
- user
description: Return channel users list registered in app
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
users:
- name: API Tester
email: ''
password: 0f79fd51905ba6398c8a7a19201e5b23
type: registered
thumbnail: /uploads/users/avatars/df9d28dc86881e76006be92ddcf67b63.png
broadcaster_id: api_tester
token: a9f27e5dca47b90f8e679221f83976bc
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 1570
level: 3
stats:
winsCount: 0
betsCount: 2
currentStreak: 0
status: 1
updated: true
available_points: 1570
about: ''
_id:
$id: 5fbf866a3ba52a1ded3c0f2e
- name: Cool User
email: ''
password: 9ef66123f15844a765df3edbf9e0d33e
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: f857f0b284ad18779a8855304da069ed
amount_of_credits: 15
amount_of_credits_won: 50
available_shouts: 0
expirience_points: 300
level: 2
stats:
winsCount: 1
betsCount: 1
currentStreak: 1
status: 1
updated: true
amount_of_credits_won_temp: 50
available_points: 300
active: true
polls:
5fbd1fc904e3c324c21aed48: Inception
ratings:
5fbcf1325e784e3816715935: '5'
about: ''
_id:
$id: 5fbfbf7b7938293c320ac1dc
- name: UserForBan
email: banner@ban.com
password: 16be0bcb0d7dbd781c5ca5ae01a2ad8c
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: f4c2ad1894bed34ae47b7a00df40dc84
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: true
about: Banned
_id:
$id: 5fbff72dda6e9d2d691e0953
pagination:
total: 3
currentPage: 1
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/user/getAllByBroadcaster:
get:
operationId: adminapiUserGetallbybroadcaster
summary: GetAllByBroadcaster
tags:
- user
description: Return all registered users in current broadcaster
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
users:
- name: Guest_2249igw9180
email: ''
password: cca394632dfcb9b3d429a23295e16a90
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: e42baf5bc3c8f35f956d2625b6ae12bc
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 70
level: 1
stats:
winsCount: 0
betsCount: 1
currentStreak: 0
status: 1
updated: false
available_points: 70
_id:
$id: 5fbd015287494515200b14c4
- name: Guest_2525uif5038
email: ''
password: 68dc638afb019aa92b09e478593d4420
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: 587ef2ce058e16a5417c1cdcdc564b53
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbd09c57b9b68474c5b1b5f
- name: Guest_5725vlo6829
email: ''
password: 92f30643ce97edcbd222031118c843d3
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: 50eebc6faa1a98b5bf7fc6d3333d8406
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbd4225f74c7c76ee3a58d9
- name: Guest_1500ran1610
email: ''
password: d60b0ccb361c00b503d7a5ce7c7df757
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: 6112cb40c1f12b89dd4e673a37a6c0fd
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbe00ff05b6c2228f63f49d
- name: Guest_4641gka885
email: ''
password: 0f79fd51905ba6398c8a7a19201e5b23
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: a9f27e5dca47b90f8e679221f83976bc
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbf866a3ba52a1ded3c0f2e
pagination:
total: 5
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/user/loginNew:
get:
operationId: adminapiUserLogin
summary: Login
tags:
- user
description: Request to login in admin system, return token and user id, token will be saved in
cookies, all rest requests take it for Authentication header for api permission
parameters:
- name: username
in: query
required: false
schema:
type: string
- name: password
in: query
required: false
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
token: 7c465d9a77540b686e818320c660d964
userId: 5fbce6c58703d05e5a73b6f4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/user/register:
get:
operationId: adminapiUserRegister
summary: Register
tags:
- user
description: Register new user
parameters:
- name: username
in: query
required: false
schema:
type: string
- name: password
in: query
required: false
schema:
type: string
- name: email
in: query
required: false
schema:
type: string
- name: broadcasterName
in: query
required: false
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
userId: 5fbfb64831bbd74d176cde62
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/wiki/create:
post:
operationId: adminapiWikiCreate
summary: Create
tags:
- wiki
description: Create new wiki
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
icon:
type: string
showInMenu:
type: string
content:
type: string
streamers:
type: string
type:
type: string
tweetUrl:
type: string
meta:
type: string
example:
name: Title
icon: ''
showInMenu: 'false'
content: header
streamers: ''
type: html
tweetUrl: ''
meta: '[object Object]'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
name: Title
icon: ''
showInMenu: false
content: 'header
'
streamers: []
type: html
tweetUrl: ''
meta:
left: 50px
top: 50px
width: 50px
height: 50px
expoints: '500'
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/wiki/delete/{wikiId}:
post:
operationId: adminapiWikiDelete
summary: Delete
tags:
- wiki
description: Remove selected wiki
parameters:
- name: wikiId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/wiki/getAll:
get:
operationId: adminapiWikiGetall
summary: GetAll
tags:
- wiki
description: Return wiki list
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
wikis:
- name: Test Wiki
showInMenu: false
icon: ''
content: 'Hello to all!!!
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
user_id: 5fbce6c58703d05e5a73b6f4
meta:
left: 250px
top: 50px
width: 150px
height: 150px
expoints: '10'
type: html
tweetUrl: ''
_id:
$id: 5fbd060eaec04b6e6943828b
pagination:
total: 1
currentPage: '1'
totalPages: 1
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/wiki/getById/{wikiId}:
get:
operationId: adminapiWikiGetbyid
summary: GetById
tags:
- wiki
description: Return wiki with given id
parameters:
- name: wikiId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
wiki:
name: Test Wiki
showInMenu: false
icon: ''
content: 'Hello to all!!!
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
user_id: 5fbce6c58703d05e5a73b6f4
meta:
left: 250px
top: 50px
width: 150px
height: 150px
expoints: '10'
type: html
tweetUrl: ''
_id:
$id: 5fbd060eaec04b6e6943828b
incorrectAnswers: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/adminApi/wiki/update/{wikiId}:
post:
operationId: adminapiWikiUpdate
summary: Update
tags:
- wiki
description: Update selected wiki
parameters:
- name: wikiId
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
wiki:
name: Title
showInMenu: false
icon: ''
content: 'header
'
streamers: []
meta:
left: 50px
top: 50px
width: 50px
height: 50px
expoints: '500'
type: html
tweetUrl: ''
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/leaderboards/leaderboardEngine_new_2:
get:
operationId: socketLeaderboard
summary: Leaderboard
tags:
- socket
description: Socket message returns winners array with info about won points, current streak
responses:
'200':
description: SocketTest
content:
text/plain:
schema:
type: string
example: "{\r\n \"0\": \"leaderboard\",\r\n \"1\": {\r\n \"winners\": [{\r\n\
\ \"amount_of_credits\": \"15\",\r\n \"amount_of_credits_won\":\
\ \"1500\",\r\n \"amount_of_credits_won_temp\": \"1500\",\r\n \"\
available_points\": \"1500\",\r\n \"available_shouts\": \"0\",\r\n \
\ \"broadcaster_id\": \"api_tester\",\r\n \"email\": \"\",\r\n \
\ \"expirience_points\": \"1500\",\r\n \"level\": \"3\",\r\n \"\
name\": \"Guest_0655shb1078\",\r\n \"password\": \"3c940a3a0e7a30"
'404':
description: Not found
'500':
description: Server error
/upload/scanDir/streamer:
post:
operationId: adminapiUploadsScandir
summary: ScanDir
tags:
- uploads
description: Load on screen saved image
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
uploadPath: /uploads/streamers
images: []
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/upload/uploadImage:
post:
operationId: adminapiUploadsUploadimage
summary: UploadImage
tags:
- uploads
description: 'Upload selected image to relevant directory on the server. Form data: file - file
itself; terget: folder to upload'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
target:
type: string
example:
target: '{folder_to_upload}'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
filepath: /uploads/entities/ee456eadddd6b031e22ae6df1f849964.3f4427d78a721b6281b681a528fbf5fe.png
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/upload/uploadVideo:
post:
operationId: adminapiUploadsUploadvideo
summary: UploadVideo
tags:
- uploads
description: 'Upload selected video with form data: file - video format file binary; target - folder
to upload'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
target:
type: string
example:
file: binary
target: folder
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
filepath: /uploads/videos/streamers/2aa7f0ca05f87f6a0e7b4ddbb614a23e.fba66777a7fade4c142dc97eb8895c0b.mp4
'404':
description: Not found
'500':
description: Server error
security:
- AdminToken: []
/userApi/analytics/add:
post:
operationId: userapiAnalyticsAdd
summary: Add
tags:
- analytics
description: add user activity to db
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
status: success
'404':
description: Not found
'500':
description: Server error
/userApi/chat/banChatUser:
post:
operationId: userapiChatBanuser
summary: BanUser
tags:
- chat
description: Send user data for ban in chat
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: APITest
content:
application/json:
schema:
type: object
example:
name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: true
rating: true
rating_menu: true
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks:
- id: 5fbd060eaec04b6e6943828b
module: wiki
timeToStay: '10'
time: 0
simpleModule: null
- id: 5fbd096648196740b75d323c
simpleModule: null
timeToStay: '10'
module: quiz
time: 15
- id: 5fbd07fc48196740b75d323b
module: polls
timeToStay: '10'
time: '25'
simpleModule: null
- id: 5fbd09ff0174d8346b7cce86
module: wiki
timeToStay: '10'
time: '50'
simpleModule: null
streamSourceType: file
moderators:
- userId: 5fbfbf7b7938293c320ac1dc
name: Cool User
email: ''
- userId: 5fbf866a3ba52a1ded3c0f2e
name: API Tester
email: ''
banList:
- userId: 5fbff72dda6e9d2d691e0953
name: UserForBan
email: banner@ban.com
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: '15'
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: manual
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
moderator_data:
- _id:
$oid: 5fbcf1b4a759e61e0f7b0bc4
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList:
- ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
_id:
$id: 5fbcee2e636497107a1cbdf4
'404':
description: Not found
'500':
description: Server error
/userApi/chat/chatMessage:
post:
operationId: userapiChatSend
summary: Send
tags:
- chat
description: Send user message and return verified text to client
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
message:
message: Hello Bro!Q!!
username: Cool User
userId: 5fbfbf7b7938293c320ac1dc
'404':
description: Not found
'500':
description: Server error
/userApi/chat/deleteChatMessage:
post:
operationId: userapiChatDelete
summary: Delete
tags:
- chat
description: Delete message from chat with provided id
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
status: success
'404':
description: Not found
'500':
description: Server error
/userApi/entity/add:
post:
operationId: userapiEntityAdd
summary: Add
tags:
- entity
description: Create entity by user choice
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: APITest
content:
application/json:
schema:
type: object
example:
answer:
userId: '***'
entityId: '***'
entityName: '***'
isAdded: true
'404':
description: Not found
'500':
description: Server error
/userApi/entity/remove:
post:
operationId: userapiEntityRemove
summary: Remove
tags:
- entity
description: Delete entity from user entities
requestBody:
content:
application/json:
schema:
type: object
example:
data:
entityId: '***'
channelId: '***'
userToken: '***'
responses:
'200':
description: Default
content:
application/json:
schema:
type: object
example:
status: success
'404':
description: Not found
'500':
description: Server error
/userApi/general/getGeneralData:
post:
operationId: userapiGeneralGetgeneraldata
summary: GetGeneralData
tags:
- general
description: "Loads the following general data:\n - translations\n - levels\n - expoints"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
translations:
language: en
countryCode: US
userIp: 172.31.248.118
extendedData:
levels:
- id: '1'
name: '1'
points: '700'
nickname: Apprentice
open_event_id: '0'
give_prize_id: '7'
static_bet_limit: '500'
- id: '2'
name: '2'
points: '1000'
nickname: Scorer
open_event_id: '0'
give_prize_id: '7'
static_bet_limit: '700'
- id: '3'
name: '3'
points: '2000'
nickname: Hawk
open_event_id: '0'
give_prize_id: '7'
static_bet_limit: '900'
- id: '4'
name: '4'
points: '4000'
nickname: Analyzer
open_event_id: '0'
give_prize_id: '5'
static_bet_limit: '1000'
- id: '5'
name: '5'
points: '7000'
nickname: Strategist
open_event_id: '0'
give_prize_id: '4'
static_bet_limit: '1200'
- id: '6'
name: '6'
points: '10000'
nickname: Expert
open_event_id: '0'
give_prize_id: '4'
static_bet_limit: '1500'
- id: '7'
name: '7'
points: '15000'
nickname: Master
open_event_id: '0'
give_prize_id: '4'
static_bet_limit: '3000'
- id: '8'
name: '8'
points: '20000'
nickname: Royal
open_event_id: '0'
give_prize_id: '3'
static_bet_limit: '5000'
- id: '9'
name: '9'
points: '30000'
nickname: Guru
open_event_id: '0'
give_prize_id: '1'
static_bet_limit: '10000'
- id: '10'
name: '10'
points: '40000'
nickname: Oracle
open_event_id: '0'
give_prize_id: '2'
static_bet_limit: '20000'
- id: '11'
name: '11'
points: '1000000'
nickname: The Ninja
open_event_id: '0'
give_prize_id: '0'
static_bet_limit: '50000'
expointsPerActions:
staticBet:
id: '4'
name: staticBet
points: '100'
status: active
staticBet_1:
id: '5'
name: staticBet_1
points: '100'
status: active
dynamicBet:
id: '6'
name: dynamicBet
points: '10'
status: active
dynamicBet_1:
id: '7'
name: dynamicBet_1
points: '1000'
status: active
matchAttendance:
id: '8'
name: matchAttendance
points: '50'
status: active
matchAttendance_2:
id: '9'
name: matchAttendance_2
points: '100'
status: active
openLoot:
id: '11'
name: openLoot
points: '100'
status: active
finishedOnboarding:
id: '12'
name: finishedOnboarding
points: '500'
status: active
creating_shout:
id: '13'
name: creating_shout
points: '100'
status: active
lootFeatured: []
'404':
description: Not found
'500':
description: Server error
/userApi/leaderboard/get/{broadcaster}:
get:
operationId: userapiLeaderboardGet
summary: Get
tags:
- leaderboard
description: Return users data list
parameters:
- name: broadcaster
in: path
required: true
schema:
type: string
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
api_tester:
- name: Guest_1545hbu6587
email: ''
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
amount_of_credits: 15
amount_of_credits_won: 50
available_shouts: 0
expirience_points: 70
level: 1
stats:
winsCount: 1
betsCount: 1
currentStreak: 1
status: 1
updated: false
amount_of_credits_won_temp: 50
available_points: 70
_id:
$id: 5fbfbf7b7938293c320ac1dc
'404':
description: Not found
'500':
description: Server error
/userApi/poll/answer_new/{questionId}:
post:
operationId: userapiPollAnswer
summary: Answer
tags:
- poll
description: Send user answer data and save it in db
parameters:
- name: questionId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
answer:
userId: 5fbfbf7b7938293c320ac1dc
questionId: 5fbd1fc904e3c324c21aed48
answer: Inception
channelId: test_channel
isAnswered: true
expoints_given: '150'
userLevel: 1
'404':
description: Not found
'500':
description: Server error
/userApi/rating/answer_new/{questionId}:
post:
operationId: userapiRatingAnswer
summary: Answer
tags:
- rating
description: Send user answer data and save it in db
parameters:
- name: questionId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
answer:
userId: 5fbfbf7b7938293c320ac1dc
ratingId: 5fbcf1325e784e3816715935
answer: 5
channelId: test_channel
isAnswered: true
expoints_given: '80'
userLevel: 2
'404':
description: Not found
'500':
description: Server error
/userApi/shop/buyItem:
post:
operationId: userapiShopBuyitem
summary: BuyItem
tags:
- shop
description: Send item data paid by user
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: APITest
content:
application/json:
schema:
type: object
example:
status: success
'404':
description: Not found
'500':
description: Server error
/userApi/shop/getProducts:
post:
operationId: userapiShopGetproducts
summary: GetProducts
tags:
- shop
description: Return list of users purchases for broadcaster
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: APITest
content:
application/json:
schema:
type: object
example:
- name: test item
description: test
pointsXP: '100'
user_id: 5fbce6c58703d05e5a73b6f4
image: /uploads/shop/4c043d20a7673bcc1189956cef8edc63.ba46792ede92a2eec53f35d8fd4c49e7.png
_id:
$id: 5fbcee8ae6cc2a181c6d5422
'404':
description: Not found
'500':
description: Server error
/userApi/streamer/getInfo:
post:
operationId: userapiStreamerGetinfo
summary: GetInfo
tags:
- streamer
description: Load all related information about streamer
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
name: Test page
useUrl: false
channel_name: test_channel
channel_id: test_channel
broadcaster_id: api_tester
pageUrl: ''
additionalPageSettings: ''
stream_url: https://api-dev.inthegame.io/uploads/videos/streamers/9240e2fbfca8dcf912016b83541a6325.ba46792ede92a2eec53f35d8fd4c49e7.mp4
chat_url: ''
registration_bonus: ''
game: Test category
game_id: 5fbceda5636497107a1cbdf3
is_permanent: 1
is_featured: 0
status: 1
modules:
logo: true
is_open_menu: false
predictions: false
predictions_menu: false
leaderboard: true
leaderboard_menu: true
leaderboard_icon: false
leaderboard_icon_image: ''
account: true
account_menu: true
account_icon: false
account_icon_image: ''
shouts: false
shouts_menu: false
quiz: true
polls: true
polls_menu: true
poll_icon: false
poll_icon_image: ''
contact: false
contact_menu: false
chat: true
chat_menu: true
wiki: true
rating: true
rating_menu: true
rating_icon: false
rating_icon_image: ''
retention: false
close: true
shop: true
shop_menu: true
clocks:
- id: 5fbd060eaec04b6e6943828b
module: wiki
timeToStay: '10'
time: 0
simpleModule: null
- id: 5fbd07fc48196740b75d323b
module: polls
timeToStay: '10'
time: '25'
- id: 5fbd096648196740b75d323c
simpleModule: null
timeToStay: '10'
module: quiz
time: 15
- id: 5fbd09ff0174d8346b7cce86
module: wiki
timeToStay: '10'
time: '50'
streamSourceType: file
moderators: []
banList: []
offersInterval: 0
direction: 0
user_id: 5fbce6c58703d05e5a73b6f4
chatDelay: 0
profanityList:
- ''
useCustomProfanity: false
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
languagesList: []
customCSS: ''
hide_on_smartphone_portrait_mode: true
approvalMessageMode: timer
broadcasterUseBlocks:
chat:
customCoords:
x: 0
y: 0
useCustomCoords: false
rating:
customCoords:
x: 0
y: 0
useCustomCoords: false
polls:
customCoords:
x: 0
y: 0
useCustomCoords: false
position: 0
moderator_data:
- _id:
$oid: 5fbcf1b4a759e61e0f7b0bc4
user_id: 5fbce6c58703d05e5a73b6f4
banList: []
profanityList:
- ''
useCustomProfanity: true
customCSS: ''
levelsDefinition:
- level: 1
name: novice
expoints: 50
- level: 2
name: advanced
expoints: 300
- level: 3
name: pro
expoints: 1000
- level: 4
name: legendary
expoints: 5000
streamer:
chat_url: ''
stream_url: ''
registration_bonus: 0
streamSourceType: ''
game: ''
game_id: null
position: 0
modules:
logo: true
predictions: true
predictions_menu: true
leaderboard: true
leaderboard_menu: true
account: true
account_menu: true
shouts: true
shouts_menu: true
quiz: true
quiz_menu: true
polls: true
polls_menu: true
contact: true
contact_menu: true
chat: true
chat_menu: true
wiki: false
wiki_menu: false
rating: false
rating_menu: false
retention: false
close: false
shop: true
shop_menu: true
clocks: []
offersInterval: 0
chatDelay: 0
streamerLogo: ''
wikiList: []
additionalInfo:
wikiTitle: Wiki
broadcaster_name: api_tester
id: 5fbcee2e636497107a1cbdf4
polls:
- id: 5fbcf049f2d31b5bc07df5ce
name: Test poll
question: Filling good?
questionType: poll
type: streamer
hideButtons: 0
image: ''
time_limit: 0
items:
- id: 5fbcee2e636497107a1cbdf4
name: test_channel
viewType: numbers
answers:
- answer: 'Yes'
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: 'No'
image: ''
reward: 0
isRewardSent: false
answerSending: false
- answer: So so
image: ''
reward: 0
isRewardSent: false
answerSending: false
expoints: '200'
prizes: []
ratings:
- id: 5fbcf1325e784e3816715935
name: Harry Potter
description: film
icon: ''
optionsNumber: '5'
averageRate: 0
totalPeople: 0
totalPoints: 0
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
expoints: '80'
prizes: []
wikis:
- id: 5fbd060eaec04b6e6943828b
name: Test Wiki
showInMenu: false
icon: ''
content: 'Hello to all!!!
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
meta:
left: 250px
top: 50px
width: 150px
height: 150px
expoints: '10'
type: html
tweetUrl: ''
prizes: []
- id: 5fbd09ff0174d8346b7cce86
name: Whats Up
showInMenu: false
icon: ''
content: 'What's UP BRO?
'
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
meta:
left: 60px
top: 60px
width: 300px
height: 300px
expoints: '150'
type: html
tweetUrl: ''
prizes: []
advertising:
- name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
lastSentTime: 1606401871
sponsorLogo: ''
_id:
$id: 5fbcef0cf2d31b5bc07df5cc
offers:
- name: test promo
place: ''
streamers:
- id: 5fbcee2e636497107a1cbdf4
channel_name: test_channel
description: test
url: test.com
thumbnail: ''
itemType: big
items: []
content: 'Welcome to my channel
'
sponsor: 5fbcee9ce1a5930b1508c482
type: offers
viewType:
- flip
secondsDelay: 5
user_id: 5fbce6c58703d05e5a73b6f4
offersOptions:
sendToChat: true
chatMessage: Welcome!!!
interval: '1'
meta:
left: 50px
top: 50px
width: 80px
height: 80px
expoints: '500'
lastSentTime: 1606401871
sponsorLogo: ''
_id:
$id: 5fbcef0cf2d31b5bc07df5cc
'404':
description: Not found
'500':
description: Server error
/userApi/trivia/answer/{questionId}:
post:
operationId: userapiTriviaAnswer
summary: Answer
tags:
- trivia
description: Sned user answer data and save it in db
parameters:
- name: questionId
in: path
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
answer:
userId: 5fbf866a3ba52a1ded3c0f2e
questionId: 5fbd096648196740b75d323c
pointsGiven: 1500
answer: Vacation
correctAnswer: Tambourine
isCorrect: false
expoints_given: '1500'
points: 1500
userLevel: 3
'404':
description: Not found
'500':
description: Server error
/userApi/user/getAvailableAvatars:
post:
operationId: userapiUserGetavailableavatars
summary: GetAvailableAvatars
tags:
- user
description: Load default icons/emojies for account
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: zombie
shortcut: zombie
item_order: 1
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage1123.png
_id:
$id: 5fbcee5aa759e61e0f7b0b87
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: ninja
shortcut: ninja
item_order: 2
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage3.png
_id:
$id: 5fbcee5aa759e61e0f7b0b88
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: crossbones
shortcut: crossbones
item_order: 3
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage4.png
_id:
$id: 5fbcee5aa759e61e0f7b0b89
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Robot
shortcut: Robot
item_order: 4
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage5.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8a
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Buldog
shortcut: Buldog
item_order: 5
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage6.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8b
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Boom
shortcut: Boom
item_order: 6
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage7.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8c
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: 'Viking '
shortcut: 'Viking '
item_order: 7
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage8.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8d
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Monkey
shortcut: Monkey
item_order: 8
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage9.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8e
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: 'Warrior '
shortcut: 'Warrior '
item_order: 9
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage9.png
_id:
$id: 5fbcee5aa759e61e0f7b0b8f
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: 'Alien '
shortcut: 'Alien '
item_order: 11
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/rImage11.png
_id:
$id: 5fbcee5aa759e61e0f7b0b90
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Big-hair
shortcut: Big-hair
item_order: 12
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Afro.png
_id:
$id: 5fbcee5aa759e61e0f7b0b91
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: DaBear
shortcut: DaBear
item_order: 13
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Bear_Mask.png
_id:
$id: 5fbcee5aa759e61e0f7b0b92
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Bully
shortcut: Bully
item_order: 14
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Bull.png
_id:
$id: 5fbcee5aa759e61e0f7b0b93
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: cateyes
shortcut: cateyes
item_order: 15
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Cat_Glasses.png
_id:
$id: 5fbcee5aa759e61e0f7b0b94
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: drago
shortcut: drago
item_order: 16
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Chinese_Dragon.png
_id:
$id: 5fbcee5aa759e61e0f7b0b95
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: fishy
shortcut: fishy
item_order: 17
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Colorful_Fish.png
_id:
$id: 5fbcee5aa759e61e0f7b0b96
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: daragonfire
shortcut: daragonfire
item_order: 18
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Dragon_Flames.png
_id:
$id: 5fbcee5aa759e61e0f7b0b97
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Dude
shortcut: Dude
item_order: 19
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Dude.png
_id:
$id: 5fbcee5aa759e61e0f7b0b98
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: dragondance
shortcut: dragondance
item_order: 20
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Dragons_Flames.png
_id:
$id: 5fbcee5aa759e61e0f7b0b99
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: ninjafloat
shortcut: ninjafloat
item_order: 21
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Floating_Ninja.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9a
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: koooala
shortcut: koooala
item_order: 22
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Koala.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9b
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: doggydo
shortcut: doggydo
item_order: 23
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Multi_Color_Dog.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9c
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: mysterygirl
shortcut: mysterygirl
item_order: 24
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Mysterious_Girl.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9d
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: ninjaslice
shortcut: ninjaslice
item_order: 25
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Ninja_Sword.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9e
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: ooowl
shortcut: ooowl
item_order: 26
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Owl.png
_id:
$id: 5fbcee5aa759e61e0f7b0b9f
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: owlyeyes
shortcut: owlyeyes
item_order: 27
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Owl_Eyes.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba0
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: piradog
shortcut: piradog
item_order: 28
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Pirate_Dog.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba1
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: spartaneous
shortcut: spartaneous
item_order: 29
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Spartan.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba2
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Sunny
shortcut: Sunny
item_order: 30
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Sun.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba3
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Val
shortcut: Val
item_order: 31
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Valkyrie.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba4
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Irule
shortcut: Irule
item_order: 32
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Warrior.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba5
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: wolfy
shortcut: wolfy
item_order: 33
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Wolf.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba6
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: gorillA
shortcut: gorillA
item_order: 34
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Aztec_Gorilla.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba7
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: LIOroars
shortcut: LIOroars
item_order: 35
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Lion.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba8
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: pantherio
shortcut: pantherio
item_order: 36
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Panther.png
_id:
$id: 5fbcee5aa759e61e0f7b0ba9
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Tigris
shortcut: Tigris
item_order: 37
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/Avatar_Tiger.png
_id:
$id: 5fbcee5aa759e61e0f7b0baa
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Bull111
shortcut: Bull111
item_order: 38
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/avatarbull.png
_id:
$id: 5fbcee5aa759e61e0f7b0bab
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: whhhhaa??
shortcut: whhhhaa??
item_order: 39
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/marmadeAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bac
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: 'Celebrates & farts '
shortcut: 'Celebrates & farts '
item_order: 40
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/celebrateFartAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bad
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: Monster Rocks
shortcut: Monster Rocks
item_order: 41
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/monsterAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bae
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: love-hate
shortcut: love-hate
item_order: 42
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/loveHateAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0baf
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: 'Geekydude tomato '
shortcut: 'Geekydude tomato '
item_order: 43
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/geekyAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb0
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: AlienDisco Avatar
shortcut: AlienDisco Avatar
item_order: 44
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/alienAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb1
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: LoserDance Ava
shortcut: LoserDance Ava
item_order: 45
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/dancingGirlGun.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb2
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: PopFairyAvatar
shortcut: PopFairyAvatar
item_order: 46
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/popFairyAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb3
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: DancingGirlKissingAvatar
shortcut: DancingGirlKissingAvatar
item_order: 47
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/dancingGirlKissAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb4
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: DancingGuitarAvatar
shortcut: DancingGuitarAvatar
item_order: 48
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/dancingGuitarAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb5
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: CryingElephantAvatar
shortcut: CryingElephantAvatar
item_order: 49
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/cryingElephantAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb6
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: HeadFallsAvatar
shortcut: HeadFallsAvatar
item_order: 50
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/headFallsAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb7
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: TrollKissAvatar
shortcut: TrollKissAvatar
item_order: 51
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/trollKissAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb8
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: getOurAvatar
shortcut: getOurAvatar
item_order: 52
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/getOutAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bb9
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: theFingerAvatar
shortcut: theFingerAvatar
item_order: 53
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/theFingerAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bba
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: GoalDanceAvatar
shortcut: GoalDanceAvatar
item_order: 54
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/goalDanceAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bbb
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: FairyDanceAvatar
shortcut: FairyDanceAvatar
item_order: 55
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/fairyDanceAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bbc
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: dancerCallingAvatar
shortcut: dancerCallingAvatar
item_order: 56
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/dancerCallingAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bbd
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: geekyAvatar
shortcut: geekyAvatar
item_order: 57
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/geekyAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bbe
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: geekyDanceAvatar
shortcut: geekyDanceAvatar
item_order: 58
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/geekyDanceAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bbf
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: swirlDanceAvatar
shortcut: swirlDanceAvatar
item_order: 59
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/swirlDanceAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bc0
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: alienStillAvatar
shortcut: alienStillAvatar
item_order: 60
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/alienStillAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bc1
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: MonsterRocksAvatar
shortcut: MonsterRocksAvatar
item_order: 61
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/MonsterRocksAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bc2
- user_id: 5fbce6c58703d05e5a73b6f4
broadcaster_name: api_tester
name: TrollFallsAvatar
shortcut: TrollFallsAvatar
item_order: 62
status: active
type: thumbnail
game_id: 0
thumbnail: /uploads/products/TrollFallsAvatar.gif
_id:
$id: 5fbcee5aa759e61e0f7b0bc3
'404':
description: Not found
'500':
description: Server error
/userApi/user/login_by_credentials:
post:
operationId: userapiUserLoginbycredentials
summary: LoginByCredentials
tags:
- user
description: 'Request for login by user/password '
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: Success
'404':
description: Not found
'500':
description: Server error
/userApi/user/login_by_token:
post:
operationId: userapiUserLoginbytoken
summary: LoginByToken
tags:
- user
description: User log in by the token var got in register
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
name: Guest_4641gka885
email: ''
password: 0f79fd51905ba6398c8a7a19201e5b23
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: a9f27e5dca47b90f8e679221f83976bc
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbf866a3ba52a1ded3c0f2e
id: 5fbf866a3ba52a1ded3c0f2e
pollAnswers: []
'404':
description: Not found
'500':
description: Server error
/userApi/user/register:
post:
operationId: userapiUserRegister
summary: Register
tags:
- user
description: User registration - the function creates a random username and token
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
name: Guest_1224wdv2006
email: ''
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: api_tester
token: 64723930231c7b8717c73c26c2c887cf
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: 1
updated: false
_id:
$id: 5fbfba8c7c61e50cd46ce805
action: register
id: 5fbfba8c7c61e50cd46ce805
pollAnswers: []
openBets: []
'404':
description: Not found
'500':
description: Server error
/userApi/user/sendPasswordToEmail:
post:
operationId: userapiUserSendpasswordtoemail
summary: SendPasswordToEmail
tags:
- user
description: To recover password generate new password and send to user e-mail
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
result: emailError
'404':
description: Not found
'500':
description: Server error
/userApi/user/update:
post:
operationId: userapiUserUpdate
summary: Update
tags:
- user
description: Update user details
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
request:
type: string
example:
request: data
responses:
'200':
description: Default
content:
application/json:
schema:
type: object
example:
name: Guest_2447bqm7535
email: ''
password: '***'
type: registered
thumbnail: /uploads/default_avatar.png
broadcaster_id: '***'
token: '***'
amount_of_credits: 15
amount_of_credits_won: 0
available_shouts: 0
expirience_points: 0
level: 1
stats:
winsCount: 0
betsCount: 0
currentStreak: 0
status: success
updated: true
_id:
$id: '***'
id: '***'
about: ''
'404':
description: Not found
'500':
description: Server error
/userApi/user/uploadAvatar:
post:
operationId: userapiUserUploadavatar
summary: UploadAvatar
tags:
- user
description: Upload New Avatar
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
type:
type: string
token:
type: string
example:
file: (binary)
type: file
token: '****'
responses:
'200':
description: API Test
content:
application/json:
schema:
type: object
example:
filepath: /uploads/users/avatars/df9d28dc86881e76006be92ddcf67b63.png
'404':
description: Not found
'500':
description: Server error