Sign in

Channels

Methods of the “MAX: channels” group. On the right — a request and response example for each.

Channel catalog

GET/v1/max/channels/
1 unitall plans, including “API.Max Test”

Catalog of active MAX channels (or group chats with kind=chat) filtered by title, category, territory, subscriber count, the A+ mark and owner verification. Always sorted in descending order: subscribers (default), quality index, citation index or last post time. Pages of up to 100 cards; the next page link is in the next field (null — no more pages).

With the ids parameter (up to 100 comma-separated numbers) you get the cards of those channels in request order: other filters and pagination don’t apply, invisible and unknown numbers are skipped. Private channels are visible only to the organization they are open to.

Parameters

NameWhereDescription
a_plus
yes / no
queryOnly with the A+ mark (true) or without it (false)
category
string
queryCategory code (primary or additional) from /v1/max/categories/
cursor
string
queryNext page cursor — use the ready link from the next field
ids
string
queryUp to 100 comma-separated channel IDs — cards in the same order, without filters or pages
kind
string
querychannel — channels (default), chat — group chats
Values: channel, chat
limit
number
queryRows per page: 1–100, 50 by default
ordering
string
queryOrdering, always descending
Values: -citation, -last_post_at, -quality, -subscribers
q
string
querySearch: part of the title or handle (3+ characters), a max.ru/… link or @handle
subscribers_max
number
querySubscribers at most
subscribers_min
number
querySubscribers at least
territory
string
queryTerritory code from /v1/max/territories/ — including its descendants
verified
yes / no
queryOnly owner-verified (true) or not (false)

Response fields

FieldTypeDescription
resultslistChannel cards on this page
results[].idnumberdatool.ru channel number — use it to request statistics and posts
results[].external_idnumber or nullChat ID in MAX (signed, as in MAX)
results[].handlestringPublic handle without @, or empty
results[].linkstringChannel link in MAX (max.ru/…) or an empty string
results[].kindstringchannel — a channel, chat — a group chat
results[].statusstringCatalog state: active — shown; new — not checked yet; unavailable — MAX answers “not found”; removed — removed from the datool.ru catalog (posts of such channels are not returned)
results[].titlestringChannel title in MAX
results[].descriptionstringChannel description from MAX (may be empty)
results[].avatar_urlstring or nullAvatar — our copy via the media.datool.ru CDN, or null
results[].subscribersnumber or nullSubscribers (members for a chat) as of the last poll
results[].posts_totalnumber or nullMessages in MAX as of the last poll
results[].is_publicyes / noPublic channel (true) or private, invite-only (false); for a private one the API returns only the card
results[].a_plusyes / noA+ mark from MAX (Roskomnadzor registry)
results[].verifiedyes / noThe owner verified the channel via the datool.ru bot
results[].categorystring or nullPrimary category code or null
results[].categorieslistAll channel categories (up to 5)
results[].territoryobject or nullChannel territory or null
results[].tagslistChannel tags
results[].qualitynumber or nullQuality index 0–100 or null
results[].citationnumber or nullCitation index or null
results[].adultyes / noThe categories include “Adults only (18+)”
results[].last_post_atdate and time or nullLast post time (ISO 8601, Moscow time, +03:00)
results[].first_seen_atdate and timeWhen datool.ru found the channel (ISO 8601, Moscow time)
results[].updated_atdate and timeWhen the card was last updated (ISO 8601, Moscow time)
results[].page_urlstringChannel page on max.datool.ru
nextstring or nullNext page URL or null

Errors

CodecodeWhen
400field errorsAn invalid parameter or body field: the error comes under the field name, for example {"channels": ["Comma-separated channel numbers."]}.
401not_authenticated / authentication_failedNo key, the key is wrong or revoked, the member is suspended or the key’s organization is archived.
429rate_limited / quota_exceeded / throttledToo often (more requests per second than your plan allows) or the requests for the period have run out; how long to wait is in the Retry-After header.
503timeoutThe database query took longer than 5 seconds — retry later or narrow the selection.

Channel card by ID or handle

GET/v1/max/channels/{channel}/
1 unitall plans, including “API.Max Test”

Card of a channel or group chat by datool.ru number or public handle (with or without @): title, description, subscribers, categories, territory, tags, quality and citation indexes, the A+ and owner verification marks. A private channel is visible only to the organization it is open to (it verified ownership or added it by invite); others get 404.

Parameters

NameWhereDescription
channel required
string
pathChannel ID in datool.ru or public handle (with or without @)

Response fields

FieldTypeDescription
idnumberdatool.ru channel number — use it to request statistics and posts
external_idnumber or nullChat ID in MAX (signed, as in MAX)
handlestringPublic handle without @, or empty
linkstringChannel link in MAX (max.ru/…) or an empty string
kindstringchannel — a channel, chat — a group chat
statusstringCatalog state: active — shown; new — not checked yet; unavailable — MAX answers “not found”; removed — removed from the datool.ru catalog (posts of such channels are not returned)
titlestringChannel title in MAX
descriptionstringChannel description from MAX (may be empty)
avatar_urlstring or nullAvatar — our copy via the media.datool.ru CDN, or null
subscribersnumber or nullSubscribers (members for a chat) as of the last poll
posts_totalnumber or nullMessages in MAX as of the last poll
is_publicyes / noPublic channel (true) or private, invite-only (false); for a private one the API returns only the card
a_plusyes / noA+ mark from MAX (Roskomnadzor registry)
verifiedyes / noThe owner verified the channel via the datool.ru bot
categorystring or nullPrimary category code or null
categorieslistAll channel categories (up to 5)
categories[].idnumberCategory number in the directory
categories[].slugstringCategory code (as in ?category=)
categories[].namestringCategory name
categories[].is_primaryyes / noThe channel's primary category
territoryobject or nullChannel territory or null
territory.idnumberNode number in the territory directory
territory.slugstringTerritory code (as in ?territory=)
territory.namestringTerritory name
territory.kindstringcountry, district, region or city
territory.pathstringNode codes from the country down to this node, separated by “/”
tagslistChannel tags
qualitynumber or nullQuality index 0–100 or null
citationnumber or nullCitation index or null
adultyes / noThe categories include “Adults only (18+)”
last_post_atdate and time or nullLast post time (ISO 8601, Moscow time, +03:00)
first_seen_atdate and timeWhen datool.ru found the channel (ISO 8601, Moscow time)
updated_atdate and timeWhen the card was last updated (ISO 8601, Moscow time)
page_urlstringChannel page on max.datool.ru

Errors

CodecodeWhen
401not_authenticated / authentication_failedNo key, the key is wrong or revoked, the member is suspended or the key’s organization is archived.
404not_foundThere is no object with this number or name, or you can’t see it.
429rate_limited / quota_exceeded / throttledToo often (more requests per second than your plan allows) or the requests for the period have run out; how long to wait is in the Retry-After header.
503timeoutThe database query took longer than 5 seconds — retry later or narrow the selection.

Find a channel by link or MAX ID

GET/v1/max/channels/resolve/
1 unitall plans, including “API.Max Test”

Find a channel by what you know: a max.ru/… link, a max.ru/join/… invite link, a @handle or the MAX chat ID (a negative number). The response is the channel card; the datool.ru number is in the id field — use it to request statistics and posts. A channel missing from our database — 404.

Parameters

NameWhereDescription
q required
string
queryA max.ru/… link (including an invite link), @handle or MAX chat ID (with or without the sign)

Response fields

FieldTypeDescription
idnumberdatool.ru channel number — use it to request statistics and posts
external_idnumber or nullChat ID in MAX (signed, as in MAX)
handlestringPublic handle without @, or empty
linkstringChannel link in MAX (max.ru/…) or an empty string
kindstringchannel — a channel, chat — a group chat
statusstringCatalog state: active — shown; new — not checked yet; unavailable — MAX answers “not found”; removed — removed from the datool.ru catalog (posts of such channels are not returned)
titlestringChannel title in MAX
descriptionstringChannel description from MAX (may be empty)
avatar_urlstring or nullAvatar — our copy via the media.datool.ru CDN, or null
subscribersnumber or nullSubscribers (members for a chat) as of the last poll
posts_totalnumber or nullMessages in MAX as of the last poll
is_publicyes / noPublic channel (true) or private, invite-only (false); for a private one the API returns only the card
a_plusyes / noA+ mark from MAX (Roskomnadzor registry)
verifiedyes / noThe owner verified the channel via the datool.ru bot
categorystring or nullPrimary category code or null
categorieslistAll channel categories (up to 5)
categories[].idnumberCategory number in the directory
categories[].slugstringCategory code (as in ?category=)
categories[].namestringCategory name
categories[].is_primaryyes / noThe channel's primary category
territoryobject or nullChannel territory or null
territory.idnumberNode number in the territory directory
territory.slugstringTerritory code (as in ?territory=)
territory.namestringTerritory name
territory.kindstringcountry, district, region or city
territory.pathstringNode codes from the country down to this node, separated by “/”
tagslistChannel tags
qualitynumber or nullQuality index 0–100 or null
citationnumber or nullCitation index or null
adultyes / noThe categories include “Adults only (18+)”
last_post_atdate and time or nullLast post time (ISO 8601, Moscow time, +03:00)
first_seen_atdate and timeWhen datool.ru found the channel (ISO 8601, Moscow time)
updated_atdate and timeWhen the card was last updated (ISO 8601, Moscow time)
page_urlstringChannel page on max.datool.ru

Errors

CodecodeWhen
400field errorsAn invalid parameter or body field: the error comes under the field name, for example {"channels": ["Comma-separated channel numbers."]}.
401not_authenticated / authentication_failedNo key, the key is wrong or revoked, the member is suspended or the key’s organization is archived.
429rate_limited / quota_exceeded / throttledToo often (more requests per second than your plan allows) or the requests for the period have run out; how long to wait is in the Retry-After header.
503timeoutThe database query took longer than 5 seconds — retry later or narrow the selection.

The error format, limit headers and what to do about each error are in the article “Errors”.

Was this page helpful?

You are leaving datool.ru

The link leads to an external website. datool.ru is not responsible for its content — check the address before entering passwords or payment details.

Redirecting in 10 s

Continue