HTTP API reference › Gala Launchpad › Schemas
Gala Launchpad — schemas
253 named schemas. Request and response tables on the group pages link here.
ActiveUserResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | string | no | |
| isChatParticipant | boolean | yes | |
| joinedAt | number | no | |
| profileImage | string | no | |
| userAddress | string | yes |
active user response dto
ActiveUsersResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| tokenName | string | yes | |
| total | number | yes | |
| truncated | boolean | yes | |
| type | string enum: viewers, chat_participants | yes | |
| users | array<ActiveUserResponseDto> | yes |
active users response dto
AddReactionDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| created | boolean | yes | |
| reactions | array<ReactionsByTypeResponseDto> | yes | |
| totalCount | number | yes |
add reaction data response dto
AddReactionSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | AddReactionDataResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
add reaction success envelope dto
AIModerationMode
Type: string enum: DISABLED, ADVISORY
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: DISABLED, ADVISORY | no |
ai moderation mode
AIModerationProviderStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| available | boolean | yes | |
| name | string | yes |
ai moderation provider status response dto
AIModerationResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| analysisTier | oneOf: string nullable enum: QUICK, DETAILED, | yes | |
| analysisType | AnalysisType | yes | |
| categories | array<CategoryResultResponseDto> nullable | yes | |
| confidence | number nullable | yes | |
| createdAt | string (date-time) | yes | |
| errorMessage | string nullable | yes | |
| escalatedFromQuick | boolean | yes | |
| flagId | number | yes | |
| framesAnalyzed | number nullable | yes | |
| id | number | yes | |
| processingTimeMs | number nullable | yes | |
| provider | string | yes | |
| quickScanResult | oneOf: string nullable enum: NO_ACTION, REVIEW_REQUIRED, DELETE_CONTENT, BAN_USER, DELETE_AND_BAN, | yes | |
| reasoning | string nullable | yes | |
| recommendation | oneOf: string nullable enum: NO_ACTION, REVIEW_REQUIRED, DELETE_CONTENT, BAN_USER, DELETE_AND_BAN, | yes | |
| retryCount | number | yes | |
| status | AnalysisStatus | yes | |
| summary | string nullable | yes | |
| tokensUsed | number nullable | yes | |
| updatedAt | string (date-time) | yes |
ai moderation response dto
AIModerationSettingsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | |
| escalationConfidenceThreshold | number | yes | |
| escalationRecommendations | array<AIRecommendation> | yes | |
| frameInterval | number | yes | |
| maxFrames | number | yes | |
| mode | AIModerationMode | yes | |
| provider | string | yes | |
| quickScanFrames | number | yes | |
| quickScanWidth | number | yes | |
| tieredAnalysisEnabled | boolean | yes |
ai moderation settings response dto
AIModerationStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | |
| mode | AIModerationMode | yes | |
| providerAvailable | boolean | yes | |
| providers | array<AIModerationProviderStatusResponseDto> | yes |
ai moderation status response dto
AIRecommendation
Type: string enum: NO_ACTION, REVIEW_REQUIRED, DELETE_CONTENT, BAN_USER, DELETE_AND_BAN
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: NO_ACTION, REVIEW_REQUIRED, DELETE_CONTENT, BAN_USER, DELETE_AND_BAN | no |
ai recommendation
AnalysisCategory
Type: string enum: VIOLENCE, HATE_SPEECH, SEXUAL_CONTENT, HARASSMENT, SPAM, SCAM, SELF_HARM, ILLEGAL_ACTIVITY, MISINFORMATION, COPYRIGHT, SAFE
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: VIOLENCE, HATE_SPEECH, SEXUAL_CONTENT, HARASSMENT, SPAM, SCAM, SELF_HARM, ILLEGAL_ACTIVITY, MISINFORMATION, COPYRIGHT, SAFE | no |
analysis category
AnalysisStatus
Type: string enum: PENDING, PROCESSING, COMPLETED, FAILED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: PENDING, PROCESSING, COMPLETED, FAILED | no |
analysis status
AnalysisType
Type: string enum: TEXT, IMAGE, VIDEO
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: TEXT, IMAGE, VIDEO | no |
analysis type
AnalyticsIngressAcceptedResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean | yes | |
| message | string | yes | |
| status | number | yes |
analytics ingress accepted response dto
ApiErrorEnvelope
Global HttpException bodies use status/error/message. CustomError and unhandled exception bodies use statusCode/message. /bundle errors use status/error/message.
Type: oneOf: object | object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
api error envelope
ApiErrorResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | no | Optional machine-readable error code. |
| message | string | yes | Error message. |
| statusCode | number | yes | HTTP status code. |
api error response dto
ApiKeyDelegationResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| apiKeyId | number | no | |
| createdAt | string (date-time) | no | |
| id | number | yes | |
| permissions | array<string enum: MANAGE_COMMUNITY, MANAGE_STREAM, MANAGE_SETTINGS, MANAGE_RECORDINGS, VIEW_ANALYTICS> nullable | no | |
| tokenName | string | yes |
api key delegation response dto
ApiKeyListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| apiKeys | array<ApiKeyResponseDto> | yes | |
| pageInfo | ApiKeyPageInfoDto | yes |
api key list response dto
ApiKeyModelResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| createdAt | string (date-time) | yes | |
| delegateAllTokens | boolean | yes | |
| deletedAt | string (date-time) nullable | yes | |
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | |
| keyHash | string | yes | Stored SHA-256 hash from the API key model. |
| keyPrefix | string | yes | Short key prefix for identification. |
| lastUsedAt | string (date-time) nullable | yes | |
| role | string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER, OWNER | yes | |
| sourceType | string enum: OWNER, MODERATOR | yes | |
| tokenDelegations | array<ApiKeyDelegationResponseDto> | yes | |
| updatedAt | string (date-time) | yes | |
| userAddress | string | yes | Owner address from the API key model. |
api key model response dto
ApiKeyPageInfoDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
api key page info dto
ApiKeyResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| createdAt | string (date-time) | yes | |
| delegateAllTokens | boolean | yes | |
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | Unique API key identifier. |
| keyPrefix | string | yes | Short key prefix for identification. |
| lastUsedAt | string (date-time) nullable | yes | |
| role | string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER, OWNER | yes | |
| sourceType | string enum: OWNER, MODERATOR | yes | |
| tokenNames | array<string> nullable | yes | |
| tokenPermissions | object nullable | no | |
| updatedAt | string (date-time) | yes |
api key response dto
ApiSuccessEnvelopeMetadataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
api success envelope metadata dto
AvailablePermissionsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| permissions | array<PermissionDescriptionResponseDto> | yes | |
| presets | array<RolePermissionPresetResponseDto> | yes |
available permissions response dto
AvailableRolesResponse
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| permissions | array<string> | yes | List of all available permission names |
| roles | array<RoleInfo> | yes | List of available roles with their details |
available roles response
BanListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bans | array<BanResponseDto> | yes | |
| pageInfo | BanPageInfoResponseDto | yes |
ban list response dto
BannedUserProfileResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bio | string nullable | no | |
| createdAt | string (date-time) | no | |
| engagementBadge | oneOf: EngagementBadge | string nullable enum: | no | |
| fullName | string nullable | yes | |
| launchBadge | oneOf: LaunchBadge | string nullable enum: | no | |
| profileImage | string nullable | yes | |
| successBadge | oneOf: SuccessBadge | string nullable enum: | no | |
| volumeBadge | oneOf: VolumeBadge | string nullable enum: | no |
banned user profile response dto
BanPageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
ban page info response dto
BanResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bannedBy | string | yes | |
| createdAt | string (date-time) | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | |
| isPermanent | boolean | yes | |
| reason | string nullable | yes | |
| tokenName | string nullable | yes | |
| user | BannedUserProfileResponseDto | no | |
| userAddress | string | yes |
ban response dto
BlanketInviteClaimResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimedAt | string (date-time) | yes | |
| inviteScope | InviteScope | yes | |
| role | ModeratorRole | yes |
blanket invite claim response dto
BundleAckResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | string (uuid) | yes | Server-minted bundle operation id. |
| error | boolean enum: false | yes | |
| message | string enum: Transaction Received | yes |
bundle ack response dto
BundleErrorResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | number | yes | HTTP status code. |
bundle error response dto
BundleStatus
Type: string enum: PENDING, PROCESSED, FAILED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: PENDING, PROCESSED, FAILED | no |
bundle status
BundleStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | no | Failure reason, included only when status is FAILED and a reason was stored. |
| key | string | yes | The submitted lookup id after trimming. |
| status | BundleStatus | yes |
bundle status response dto
CategoryResultResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| category | AnalysisCategory | yes | |
| confidence | number | yes | |
| detected | boolean | yes |
category result response dto
ChartCandleResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| closePrice | number | yes | |
| highPrice | number | yes | |
| lowPrice | number | yes | |
| openPrice | number | yes | |
| startTime | oneOf: number | string | yes | |
| volume | oneOf: number | string | yes |
chart candle response dto
ChartResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | array<ChartCandleResponseDto> | yes | |
| isPreviousData | boolean | yes | |
| nextTime | number | no |
chart response dto
ChatMessageResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | |
| createdAt | string (date-time) | yes | |
| holderTier | MessageHolderTierResponseDto | no | |
| id | number | no | |
| messageId | string | no | |
| reactions | ChatReactionDataResponseDto | no | |
| tokenName | string | yes | |
| user | MessageUserProfileResponseDto | no | |
| userAddress | string | yes |
chat message response dto
ChatReactionDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| reactions | array<ChatReactionsByTypeResponseDto> | yes | |
| totalCount | number | yes |
chat reaction data response dto
ChatReactionsByTypeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | yes | |
| reactionType | ContentReactionType | yes | |
| userReacted | boolean | yes | |
| users | array<ChatReactionUserResponseDto> | yes |
chat reactions by type response dto
ChatReactionUserResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | string | no | |
| profileImage | string | no | |
| userAddress | string | yes |
chat reaction user response dto
ChatStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | |
| reason | string enum: global, admin, owner | no | |
| slowModeSeconds | number | yes | |
| status | string enum: ENABLED, DISABLED, ADMIN_DISABLED | no |
chat status response dto
ClientFlagsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| flags | object | no |
client flags response dto
ConnectedClientResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | no | |
| authenticated | boolean | yes | |
| connectedAt | string (date-time) | yes | |
| lastActivity | string (date-time) | yes | |
| rooms | array<string> | yes | |
| socketId | string | yes | |
| userAgent | string | no |
connected client response dto
ConnectedClientsPaginationResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| hasMore | boolean | yes | |
| limit | number | yes | |
| offset | number | yes | |
| total | number | yes |
connected clients pagination response dto
ConnectedClientsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| clients | array<ConnectedClientResponseDto> | yes | |
| pagination | ConnectedClientsPaginationResponseDto | yes | |
| summary | ConnectedClientsSummaryResponseDto | yes |
connected clients response dto
ConnectedClientsSummaryResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| anonymousCount | number | yes | |
| authenticatedCount | number | yes | |
| overseerCount | number | no | |
| requestedUsersOnline | array<string> | no | |
| roomCounts | object | yes | |
| rooms | array<ConnectedRoomSummaryResponseDto> | yes | |
| totalConnected | number | yes |
connected clients summary response dto
ConnectedRoomSummaryResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| authenticatedCount | number | yes | |
| connectedCount | number | yes | |
| room | string | yes |
connected room summary response dto
ConnectErrorResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | number | yes |
connect error response dto
ContentFlagCategoryResultDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| category | AnalysisCategory | yes | |
| confidence | number | yes | |
| detected | boolean | yes |
content flag category result dto
ContentFlagListDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| flags | array<ContentFlagResponseDto> | yes | |
| pageInfo | ContentFlagPageInfoDto | yes |
content flag list data dto
ContentFlagListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ContentFlagListDataDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
content flag list success envelope dto
ContentFlagModerationDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| categories | array<ContentFlagCategoryResultDto> nullable | yes | |
| completedAt | string (date-time) nullable | yes | |
| confidence | number nullable | yes | |
| errorMessage | string nullable | yes | |
| provider | string nullable | yes | |
| reasoning | string nullable | yes | |
| recommendation | string nullable | yes | |
| status | AnalysisStatus | yes | |
| summary | string nullable | yes |
content flag moderation dto
ContentFlagMutationDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| flag | ContentFlagResponseDto | yes |
content flag mutation data dto
ContentFlagMutationSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ContentFlagMutationDataDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
content flag mutation success envelope dto
ContentFlagPageInfoDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
content flag page info dto
ContentFlagReporterDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bio | string nullable | no | |
| createdAt | string (date-time) | no | |
| engagementBadge | oneOf: EngagementBadge | string nullable enum: | no | |
| fullName | string nullable | yes | |
| launchBadge | oneOf: LaunchBadge | string nullable enum: | no | |
| profileImage | string nullable | yes | |
| successBadge | oneOf: SuccessBadge | string nullable enum: | no | |
| volumeBadge | oneOf: VolumeBadge | string nullable enum: | no |
content flag reporter dto
ContentFlagResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| actionTaken | oneOf: FlagAction | string nullable enum: | yes | |
| aiModeration | oneOf: ContentFlagModerationDto | object nullable enum: | no | |
| contentId | string | yes | |
| contentSnapshot | string nullable | yes | |
| contentType | ContentType | yes | |
| createdAt | string (date-time) | yes | |
| details | string nullable | yes | |
| id | number | yes | |
| reason | oneOf: FlagReason | string nullable enum: | yes | |
| reportedUserAddress | string | yes | |
| reporter | ContentFlagReporterDto | no | |
| reporterAddress | string | yes | |
| reviewedAt | string (date-time) nullable | yes | |
| reviewedBy | string nullable | yes | |
| status | FlagStatus | yes | |
| tokenName | string | yes | |
| updatedAt | string (date-time) | yes |
content flag response dto
ContentReactionType
Type: string enum: heart, fire, laugh, wow, thumbs_up
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: heart, fire, laugh, wow, thumbs_up | no |
content reaction type
ContentType
Type: string enum: CHAT_MESSAGE, COMMENT, STREAM, RECORDING
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: CHAT_MESSAGE, COMMENT, STREAM, RECORDING | no |
content type
CreateApiKeyResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| createdAt | string (date-time) | yes | |
| delegateAllTokens | boolean | yes | |
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | Unique API key identifier. |
| keyPrefix | string | yes | Short key prefix for identification. |
| lastUsedAt | string (date-time) nullable | yes | |
| rawKey | string | yes | Full API key returned only at creation. |
| role | string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER, OWNER | yes | |
| sourceType | string enum: OWNER, MODERATOR | yes | |
| tokenNames | array<string> nullable | yes | |
| tokenPermissions | object nullable | no | |
| updatedAt | string (date-time) | yes |
create api key response dto
CreateBanDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| durationSeconds | number | no | |
| reason | string | no | |
| userAddress | string (gala-chain-address) | yes |
create ban dto
CreateOverseerDirectDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | no | |
| userAddress | string | yes | GalaChain wallet address to promote. |
create overseer direct dto
CreateOverseerInviteDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | no | |
| expiresAt | string (date-time) | no |
create overseer invite dto
CreateSimulcastTargetDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| passthrough | string | no | |
| platform | string enum: youtube, twitch, facebook, custom | yes | |
| streamKey | string | yes | |
| url | string | yes |
create simulcast target dto
CreateTokenBanDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| reason | string | no | Optional reason for the ban. |
| tokenName | string | yes | Token name to ban. |
create token ban dto
CurrentUserProfileResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | yes | |
| bio | string | yes | |
| fullName | string nullable | yes | |
| launchBadge | array<UserBadgeStatusResponseDto> | yes | |
| profileImage | string nullable | yes | |
| successBadge | array<UserBadgeStatusResponseDto> | yes |
current user profile response dto
DeletedMessageDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| deleted | boolean | yes | |
| messageId | string | yes |
deleted message data response dto
DevicePlatform
Type: string enum: ios, android
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: ios, android | no |
device platform
EngagementBadge
Type: string enum: SPARK, GATHERING, CROWD, MOVEMENT
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: SPARK, GATHERING, CROWD, MOVEMENT | no |
engagement badge
EventResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| clientTimestamp | string (date-time) | no | |
| createdAt | string (date-time) | yes | |
| eventType | string | yes | |
| id | number | yes | |
| payload | object | yes | |
| sessionId | string | no | |
| tokenName | string | no | |
| updatedAt | string (date-time) | yes | |
| userAddress | string | no |
event response dto
EventsBatchResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| accepted | number | yes | |
| timestamp | string (date-time) | no |
events batch response dto
EventsBatchSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | EventsBatchResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
events batch success envelope dto
EventsListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | array<EventResponseDto> | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
events list success envelope dto
EventsStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| eventsByType | object | yes | |
| todayEvents | number | yes | |
| totalEvents | number | yes | |
| uniqueTokens | number | yes | |
| uniqueUsers | number | yes |
events stats response dto
EventsStatsSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | EventsStatsResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
events stats success envelope dto
FeeAmountResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| feeAmount | number | yes |
fee amount response dto
FlagAction
Type: string enum: DELETE_CONTENT, BAN_USER, DELETE_AND_BAN
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: DELETE_CONTENT, BAN_USER, DELETE_AND_BAN | no |
flag action
FlagReason
Type: string enum: INAPPROPRIATE_CONTENT, SPAM, HARASSMENT, SCAM, OTHER
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: INAPPROPRIATE_CONTENT, SPAM, HARASSMENT, SCAM, OTHER | no |
flag reason
FlagStatus
Type: string enum: PENDING, DISMISSED, ACTIONED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: PENDING, DISMISSED, ACTIONED | no |
flag status
FlushResultDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| duration | number | yes | Duration of the flush operation in milliseconds |
| flushedCount | number | yes | Number of cache keys flushed |
| target | string | no | Target entity that was flushed (address or tokenName) |
flush result dto
GalaBalanceResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| holdingPrice | number | yes | |
| name | string enum: GALA | yes | |
| price | number | yes | |
| quantity | number | yes |
gala balance response dto
GetAIModerationAnalysisResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| analysis | AIModerationResponseDto | yes |
get ai moderation analysis response dto
GetAIModerationSettingsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| settings | AIModerationSettingsResponseDto | yes |
get ai moderation settings response dto
GetAIModerationStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| status | AIModerationStatusResponseDto | yes |
get ai moderation status response dto
GetRestrictedNamesDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | Newline-separated list of restricted token names/patterns |
get restricted names dto
HealthCheckResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| database | HealthServiceStatusDto | no | |
| galachain_launchpad | HealthServiceStatusDto | no | |
| galachain_query | HealthServiceStatusDto | no | |
| mux | HealthServiceStatusDto | no | |
| rabbitmq | HealthServiceStatusDto | no | |
| redis | HealthServiceStatusDto | no | |
| status | string enum: up | yes |
health check response dto
HealthProbeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| details | object | yes | |
| error | object | yes | |
| info | object | yes | |
| status | string enum: ok | yes |
health probe response dto
HealthServiceStatusDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| service | string | no | |
| status | string enum: up, down | yes |
health service status dto
HolderItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Wallet address as returned by the holder service. |
| quantity | string | yes | Token quantity, represented as a decimal string. |
holder item response dto
HolderListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | array<HolderItemResponseDto> | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
holder list success envelope dto
HolderTier
Type: number enum: 0, 1, 2, 3, 4, 5
| Field | Type | Required | Description |
|---|---|---|---|
| value | number enum: 0, 1, 2, 3, 4, 5 | no |
holder tier
HolderTierResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| tier | HolderTier | yes | |
| tierName | string | yes |
holder tier response dto
InviteClaimDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| inviteCode | string | yes |
invite claim dto
InviteScope
Type: string enum: TOKEN, ALL_OWNER_TOKENS
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: TOKEN, ALL_OWNER_TOKENS | no |
invite scope
InviteStatus
Type: string enum: PENDING, CLAIMED, REVOKED, EXPIRED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: PENDING, CLAIMED, REVOKED, EXPIRED | no |
invite status
LaunchBadge
Type: string enum: ONE_HIT_WONDER, TOKEN_CRAFTER, CRYPTO_SAVVY, CRYPTO_PRO, MIDAS_TOUCH
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: ONE_HIT_WONDER, TOKEN_CRAFTER, CRYPTO_SAVVY, CRYPTO_PRO, MIDAS_TOUCH | no |
launch badge
LeaderboardTokenResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| creatorAddress | string | yes | |
| description | string | yes | |
| galaPrice | string | yes | |
| image | string | yes | |
| marketCapGala | string | yes | |
| marketCapIncreaseGala | number | yes | |
| marketCapUsd | string | yes | |
| rank | number | yes | |
| symbol | string | yes | |
| telegramUrl | string | yes | |
| tokenName | string | yes | |
| twitterUrl | string | yes | |
| usdPrice | string | yes | |
| vaultAddress | string | yes | |
| websiteUrl | string | yes |
leaderboard token response dto
LoginResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken | string | yes | |
| address | string | yes | |
| expiresIn | number | yes | |
| refreshExpiresIn | number | no | |
| refreshToken | string | no |
login response dto
ManagedTokensResponse
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| isOverseer | boolean | yes | Whether the user has platform-wide overseer access (can moderate any token) |
| moderatedTokens | array<ModeratedTokenSummary> | yes | Tokens the user has moderator access to via claimed invites |
| moderatedTokensCount | number | yes | Total number of moderated tokens (for listParams) |
| overseerSince | string nullable | yes | ISO timestamp when the user became an overseer (if applicable) |
| ownedTokens | array<OwnedTokenSummary> | yes | Tokens the user owns (has full OWNER access) |
| ownedTokensCount | number | yes | Total number of owned tokens (for listParams) |
managed tokens response
ManagedUserProfileInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | yes | |
| badges | UserBadgeDataResponseDto | yes | |
| bio | string nullable | yes | |
| createdAt | string (date-time) | yes | |
| fullName | string nullable | yes | |
| profileImage | string nullable | yes |
managed user profile info response dto
MasterAccessStatus
Type: string enum: none, preparing, ready, errored
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: none, preparing, ready, errored | no |
master access status
MessageDeleteSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | DeletedMessageDataResponseDto | no | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
message delete success envelope dto
MessageHolderTierResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| tier | HolderTier | yes | |
| tierName | string | yes |
message holder tier response dto
MessageItemReactionsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| counts | object | yes | |
| userReacted | array<string> | no |
message item reactions response dto
MessageItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | |
| createdAt | string (date-time) | yes | |
| deletedAt | string (date-time) nullable | yes | |
| flagCount | number | yes | |
| id | string | yes | |
| messageId | string | yes | |
| reactions | MessageItemReactionsResponseDto | yes | |
| tokenImage | string nullable | yes | |
| tokenName | string | yes | |
| updatedAt | string (date-time) nullable | yes | |
| user | MessageQueryUserResponseDto | yes | |
| userAddress | string | yes | |
| userProfile | MessageQueryUserResponseDto | yes |
message item response dto
MessageListDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| messages | array<MessageItemResponseDto> | yes | |
| pageInfo | MessagePageInfoResponseDto | yes |
message list data response dto
MessageListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | MessageListDataResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
message list success envelope dto
MessageMutationSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | oneOf: ChatMessageResponseDto | MessageResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
message mutation success envelope dto
MessagePageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
message page info response dto
MessageQueryUserResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | string | yes | |
| profileImage | string nullable | yes |
message query user response dto
MessageResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | |
| createdAt | string (date-time) | yes | |
| id | number | yes | |
| messageId | string | yes | |
| updatedAt | string (date-time) | yes | |
| user | object nullable | no | |
| userAddress | string | yes |
message response dto
MessageStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| messagesByType | object | yes | |
| todayMessages | number | yes | |
| totalMessages | number | yes | |
| uniqueTokens | number | yes | |
| uniqueUsers | number | yes |
message stats response dto
MessageStatsSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | MessageStatsResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
message stats success envelope dto
MessageUserProfileResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bio | string nullable | no | |
| createdAt | string (date-time) | no | |
| engagementBadge | oneOf: EngagementBadge | string nullable enum: | no | |
| fullName | string nullable | yes | |
| launchBadge | oneOf: LaunchBadge | string nullable enum: | no | |
| profileImage | string nullable | yes | |
| successBadge | oneOf: SuccessBadge | string nullable enum: | no | |
| volumeBadge | oneOf: VolumeBadge | string nullable enum: | no |
message user profile response dto
ModeratedTokenResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimedAt | string (date-time) | yes | |
| creatorAddress | string | yes | |
| inviteScope | InviteScope | yes | |
| isLive | boolean | yes | |
| muxStreamStatus | string nullable | yes | |
| role | ModeratorRole | yes | |
| tokenImage | string nullable | yes | |
| tokenName | string | yes | |
| tokenSymbol | string | yes | |
| viewerCount | number | yes |
moderated token response dto
ModeratedTokensDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | ModeratedTokensPageInfoDto | yes | |
| tokens | array<ModeratedTokenResponseDto> | yes |
moderated tokens data dto
ModeratedTokensPageInfoDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
moderated tokens page info dto
ModeratedTokensSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ModeratedTokensDataDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
moderated tokens success envelope dto
ModeratedTokenSummary
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimedAt | string | yes | When the invite was claimed |
| creatorAddress | string | yes | Address of the token creator who granted access |
| inviteScope | string enum: TOKEN, ALL_OWNER_TOKENS | yes | Scope of the moderator invite |
| isLive | boolean | yes | Whether a live stream is currently active |
| muxStreamStatus | string nullable | no | Current stream status |
| role | string enum: MANAGER, TECHNICAL_PRODUCER, MODERATOR | yes | User's role for this token |
| tokenImage | string | yes | Token image URL |
| tokenName | string | yes | Token name (lowercase identifier) |
| tokenSymbol | string | yes | Token symbol |
| viewerCount | number | yes | Current viewer count |
moderated token summary
ModeratorInviteClaimSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | oneOf: ModeratedTokenResponseDto | BlanketInviteClaimResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
moderator invite claim success envelope dto
ModeratorInviteDeleteSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
moderator invite delete success envelope dto
ModeratorInviteErrorEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes |
moderator invite error envelope dto
ModeratorInviteListDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| invites | array<ModeratorInviteResponseDto> | yes | |
| pageInfo | ModeratorInvitePageInfoDto | yes |
moderator invite list data dto
ModeratorInviteListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ModeratorInviteListDataDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
moderator invite list success envelope dto
ModeratorInvitePageInfoDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
moderator invite page info dto
ModeratorInviteResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimedAt | string (date-time) nullable | yes | |
| claimedBy | string nullable | yes | |
| createdAt | string (date-time) | yes | |
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | |
| inviteCode | string | yes | |
| inviteScope | InviteScope | yes | |
| inviteUrl | string | yes | |
| role | ModeratorRole | yes | |
| status | InviteStatus | yes | |
| tokenName | string nullable | yes |
moderator invite response dto
ModeratorInviteSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ModeratorInviteResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
moderator invite success envelope dto
ModeratorRole
Type: string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER | no |
moderator role
MuxWebhookAcceptedResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | yes | |
| error | boolean | yes | |
| message | string | yes | |
| status | number | yes |
mux webhook accepted response dto
MuxWebhookPayloadDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | yes | |
| id | string | yes | |
| type | string | yes |
mux webhook payload dto
NotificationErrorEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes |
notification error envelope dto
NotificationPreferencesDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| chatEnabled | boolean | yes | |
| streamsEnabled | boolean | yes | |
| systemEnabled | boolean | yes | |
| tradesEnabled | boolean | yes |
notification preferences dto
NotificationPreferencesSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | NotificationPreferencesDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
notification preferences success envelope dto
OEmbedErrorResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | number | yes |
embed error response dto
OEmbedJsonResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| author_name | string | yes | |
| provider_name | string | yes | |
| provider_url | string (uri) | yes | |
| thumbnail_height | number | yes | |
| thumbnail_url | string (uri) | yes | |
| thumbnail_width | number | yes | |
| title | string | yes | |
| type | string enum: link | yes | |
| version | string enum: 1.0 | yes |
embed json response dto
OverseerBanStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| total | number | yes |
overseer ban stats response dto
OverseerFlagStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| actioned | number | yes | |
| dismissed | number | yes | |
| pending | number | yes | |
| total | number | yes |
overseer flag stats response dto
OverseerInviteListDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| invites | array<OverseerInviteResponseDto> | yes | |
| pageInfo | OverseerInvitePageInfoResponseDto | yes |
overseer invite list data response dto
OverseerInvitePageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
overseer invite page info response dto
OverseerInviteResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimedAt | string (date-time) nullable | yes | |
| claimedBy | string nullable | yes | |
| createdAt | string (date-time) | yes | |
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| id | number | yes | |
| inviteCode | string | yes | |
| invitedBy | string | yes | |
| inviteUrl | string (uri) | yes | |
| status | OverseerInviteResponseStatus | yes |
overseer invite response dto
OverseerInviteResponseStatus
Type: string enum: PENDING, ACCEPTED, REVOKED, EXPIRED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: PENDING, ACCEPTED, REVOKED, EXPIRED | no |
overseer invite response status
OverseerInviteStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| claimed | number | yes | |
| pending | number | yes | |
| revoked | number | yes | |
| total | number | yes |
overseer invite stats response dto
OverseerListDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| overseers | array<OverseerResponseDto> | yes | |
| pageInfo | OverseerPageInfoResponseDto | yes |
overseer list data response dto
OverseerMeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| isOverseer | boolean | yes | |
| overseer | object nullable | yes |
overseer me response dto
OverseerPageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
overseer page info response dto
OverseerProfileResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | yes | |
| fullName | string nullable | yes | |
| profileImage | string nullable | yes |
overseer profile response dto
OverseerResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| createdAt | string (date-time) | yes | |
| id | number | yes | |
| revokedAt | string (date-time) nullable | yes | |
| revokedBy | string nullable | yes | |
| status | OverseerStatus | yes | |
| user | OverseerProfileResponseDto | yes | |
| userAddress | string | yes |
overseer response dto
OverseerStatus
Type: string enum: ACTIVE, REVOKED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: ACTIVE, REVOKED | no |
overseer status
OverseerSummaryResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| activeStreams | number | yes | |
| graduatedPools | number | yes | Pools that have graduated (isFinalized) |
| pendingFlags | number | yes | |
| totalPools | number | yes | |
| totalViewers | number | yes |
overseer summary response dto
OverseerTokenBanStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| total | number | yes |
overseer token ban stats response dto
OverseerUserStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bannedUsers | number | yes | |
| flaggedUsers | number | yes | |
| totalUsers | number | yes |
overseer user stats response dto
OwnedTokenSummary
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| isLive | boolean | yes | Whether a live stream is currently active |
| muxStreamStatus | string nullable | no | Current stream status |
| tokenImage | string | yes | Token image URL |
| tokenName | string | yes | Token name (lowercase identifier) |
| tokenSymbol | string | yes | Token symbol |
| viewerCount | number | yes | Current viewer count |
owned token summary
Permission
Type: string enum: MANAGE_COMMUNITY, MANAGE_STREAM, MANAGE_SETTINGS, MANAGE_RECORDINGS, VIEW_ANALYTICS
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: MANAGE_COMMUNITY, MANAGE_STREAM, MANAGE_SETTINGS, MANAGE_RECORDINGS, VIEW_ANALYTICS | no |
PermissionDescriptionResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | yes | |
| displayName | string | yes | |
| name | string enum: MANAGE_COMMUNITY, MANAGE_STREAM, MANAGE_SETTINGS, MANAGE_RECORDINGS, VIEW_ANALYTICS | yes |
permission description response dto
PinMessageSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | PinnedMessageResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
pin message success envelope dto
PinnedMessageResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | |
| holderTier | MessageHolderTierResponseDto | no | |
| messageId | string | yes | |
| pinnedAt | string (date-time) | yes | |
| pinnedBy | string | yes | |
| user | MessageUserProfileResponseDto | no | |
| userAddress | string | yes |
pinned message response dto
PinnedMessageSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | object nullable | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
pinned message success envelope dto
PlatformConfigResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| aiModerationAvailable | boolean | yes | |
| aiModerationEnabled | boolean | yes | |
| chatEnabled | boolean | yes | |
| commentsEnabled | boolean | yes | |
| streamingEnabled | boolean | yes | |
| webhooksEnabled | boolean | yes |
platform config response dto
PlatformConfigUpdateResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| aiModerationEnabled | boolean | yes | |
| chatEnabled | boolean | yes | |
| commentsEnabled | boolean | yes | |
| streamingEnabled | boolean | yes | |
| webhooksEnabled | boolean | yes |
platform config update response dto
PlatformStatsDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| galaVolume1h | number | yes | GALA trading volume in the last hour. |
| galaVolume24h | number | yes | GALA trading volume in the last 24 hours. |
| galaVolume7d | number | yes | GALA trading volume in the last 7 days. |
| timestamp | string (date-time) | yes | Timestamp when the statistics were calculated. |
| totalTokens | number | yes | Total number of tokens on the platform. |
platform stats dto
ProfileLaunchesResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| launches | array<ProfileLaunchItemResponseDto> | yes | |
| pageInfo | TokenPageInfoResponseDto | yes |
profile launches response dto
ProfileLaunchItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bondingCurvePercentage | number | yes | |
| createdAt | string (date-time) | yes | |
| currentViewerCount | number | yes | |
| image | string | yes | |
| isFinalized | boolean | yes | |
| muxStreamStatus | oneOf: StreamStatus | string nullable enum: | yes | |
| symbol | string | yes | |
| tokenName | string | yes | |
| vaultAddress | string | yes | |
| volume | number | yes | |
| volumeSum | number | yes |
profile launch item response dto
PublicModeratorInviteInfoDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| invitedBy | string | yes | |
| inviteScope | InviteScope | yes | |
| role | ModeratorRole | yes | |
| status | InviteStatus | yes | |
| tokenImage | string nullable | yes | |
| tokenName | string nullable | yes | |
| tokenSymbol | string nullable | yes |
public moderator invite info dto
PublicModeratorInviteSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | PublicModeratorInviteInfoDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
public moderator invite success envelope dto
PublicOverseerInviteInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string nullable | yes | |
| expiresAt | string (date-time) nullable | yes | |
| invitedBy | string | yes | |
| status | InviteStatus | yes |
public overseer invite info response dto
PublicUserProfileResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | yes | |
| bio | string nullable | yes | |
| engagementBadge | array<UserBadgeStatusResponseDto> | yes | |
| fullName | string nullable | yes | |
| isLiveStreaming | boolean | yes | |
| launchBadge | array<UserBadgeStatusResponseDto> | yes | |
| liveStreamToken | string nullable | yes | |
| profileImage | string nullable | yes | |
| stats | UserProfileStatsResponseDto | yes | |
| successBadge | array<UserBadgeStatusResponseDto> | yes | |
| volumeBadge | array<UserBadgeStatusResponseDto> | yes |
public user profile response dto
ReactionsByTypeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | yes | |
| reactionType | string enum: heart, fire, laugh, wow, thumbs_up | yes | |
| userReacted | boolean | yes | |
| users | array<ReactionUserInfoResponseDto> | yes |
reactions by type response dto
ReactionUserInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | string | no | |
| profileImage | string | no | |
| userAddress | string | yes |
reaction user info response dto
RecordingAnimatedAssetUrlsDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| gif | string | yes | |
| webp | string | yes |
recording animated asset urls dto
RecordingAssetUrlGroupDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| default | string | yes | |
| poster | string | yes | |
| ribbon | string | yes | |
| webp | string | yes |
recording asset url group dto
RecordingAssetUrlsDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| animated | RecordingAnimatedAssetUrlsDto | yes | |
| storyboard | RecordingStoryboardAssetUrlsDto | yes | |
| stream | string | yes | |
| thumbnails | RecordingAssetUrlGroupDto | yes |
recording asset urls dto
RecordingDeleteSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
recording delete success envelope dto
RecordingDownloadResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| status | RecordingDownloadStatus | yes | |
| url | string (uri) | no |
recording download response dto
RecordingDownloadStatus
Type: string enum: none, preparing, ready, errored
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: none, preparing, ready, errored | no |
recording download status
RecordingDownloadSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | RecordingDownloadResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
recording download success envelope dto
RecordingInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| aspectRatio | string | no | |
| assets | oneOf: RecordingAssetUrlsDto | object nullable enum: | no | |
| createdAt | string (date-time) | yes | |
| duration | number | yes | |
| id | string | yes | |
| masterAccess | RecordingMasterAccessDto | yes | |
| playbackId | string | yes | |
| status | string | yes |
recording info response dto
RecordingListSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | array<RecordingInfoResponseDto> | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
recording list success envelope dto
RecordingMasterAccessDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| status | MasterAccessStatus | yes | |
| url | string (uri) | no |
recording master access dto
RecordingStoryboardAssetUrlsDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| jpg | string | yes | |
| json | string | yes | |
| png | string | yes | |
| vtt | string | yes | |
| webp | string | yes |
recording storyboard asset urls dto
ReferralCodeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Referral code to share. |
| username | string | no | Gala Connect username, when available. |
referral code dto
ReferralCodeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | ReferralCodeDto | no | |
| error | boolean | yes | |
| message | string | yes | |
| status | number | yes |
referral code response dto
RefreshResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken | string | yes | |
| address | string | yes | |
| expiresIn | number | yes | |
| refreshExpiresIn | number | no | |
| refreshToken | string | no |
refresh response dto
RegisterDeviceDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| deviceId | string | no | |
| platform | DevicePlatform | yes | |
| token | string | yes |
register device dto
RegisterDeviceSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | RegisteredDeviceDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
register device success envelope dto
RegisteredDeviceDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| registered | boolean enum: true | yes |
registered device dto
RegisterPoolDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| amount | string | yes | |
| blockNumber | number | yes | |
| description | string | yes | |
| facebookUrl | string | no | |
| image | string (uri) | yes | |
| initialBuyQuantity | string | yes | |
| instagramUrl | string | no | |
| outputAmount | string | no | |
| redditUrl | string | no | |
| reverseBondingCurveConfiguration | ReverseBondingCurveConfigurationDto | no | |
| saleStartTime | number | no | |
| symbol | string | yes | |
| telegramUrl | string | no | |
| tiktokUrl | string | no | |
| tokenName | string | yes | |
| twitterUrl | string | no | |
| txnId | string | yes | |
| urls | object | yes | |
| vaultAddress | string | yes | |
| websiteUrl | string | no |
register pool dto
RemoveReactionSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
remove reaction success envelope dto
ReverseBondingCurveConfigurationDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| maxFeePortion | string | yes | |
| minFeePortion | string | yes |
reverse bonding curve configuration dto
RoleInfo
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | yes | Human-readable description of the role |
| level | number | yes | Hierarchy level (higher = more privileges). MODERATOR=0, TECHNICAL_PRODUCER=1, MANAGER=2, OWNER=3 |
| name | string enum: OWNER, MANAGER, TECHNICAL_PRODUCER, MODERATOR | yes | Role name identifier |
| permissions | array<string> | yes | List of permissions this role has |
role info
RolePermissionPresetResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| permissions | array<Permission> | yes | |
| role | string enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER | yes |
role permission preset response dto
SaleDetailsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| maxSupply | string | yes | |
| nativeTokenQuantity | string | yes | |
| saleStartTime | number | no | |
| saleStatus | string | yes | |
| sellingTokenQuantity | string | yes | |
| timeUntilLaunch | number | no |
sale details response dto
SendUnifiedMessageDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes | |
| tokenName | string | yes | |
| type | string enum: COMMENT, CHAT_MESSAGE | no |
send unified message dto
SessionResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| address | string | yes | |
| expiresAt | string (date-time) | yes | |
| issuedAt | string (date-time) | yes |
session response dto
SetChatStatusRequestDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes |
set chat status request dto
SetSlowModeRequestDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| slowModeSeconds | number | yes |
set slow mode request dto
SimulatedMessageDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| tokenName | string | yes |
simulated message data dto
SimulatedMessageResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | SimulatedMessageDataDto | yes | |
| error | boolean | yes | |
| message | string | yes | |
| status | number | yes |
simulated message response dto
SimulatedStreamStatusDataDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| previousStatus | string | yes | |
| status | string enum: ACTIVE, IDLE, DISABLED | yes | |
| tokenName | string | yes |
simulated stream status data dto
SimulatedWebhookResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | SimulatedStreamStatusDataDto | yes | |
| error | boolean | yes | |
| message | string | yes | |
| status | number | yes |
simulated webhook response dto
SimulcastTargetResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | yes | |
| passthrough | string | no | |
| status | string | yes | |
| url | string | yes |
simulcast target response dto
StreamControlStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | |
| tokenName | string | yes |
stream control status response dto
StreamCredentialsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| playbackId | string | yes | |
| rtmpsUrl | string | yes | |
| srtPassphrase | string | yes | |
| srtUrl | string | yes | |
| status | string | yes | |
| streamKey | string | yes |
stream credentials response dto
StreamStatus
Type: string enum: ACTIVE, IDLE, DISABLED
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: ACTIVE, IDLE, DISABLED | no |
stream status
SuccessBadge
Type: string enum: 250k, 1M, 10M+
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: 250k, 1M, 10M+ | no |
success badge
TokenBadgeResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| badgeName | string | yes | |
| isActive | boolean | yes |
token badge response dto
TokenBadgesResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| engagement | array<TokenBadgeResponseDto> | yes | |
| volume | array<TokenBadgeResponseDto> | yes |
token badges response dto
TokenBanListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bans | array<TokenBanResponseDto> | yes | |
| pageInfo | TokenBanPageInfoResponseDto | yes |
token ban list response dto
TokenBanPageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
token ban page info response dto
TokenBanPoolResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| creatorAddress | string | yes | |
| image | string nullable | yes | |
| symbol | string | yes |
token ban pool response dto
TokenBanResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| bannedBy | string | yes | |
| createdAt | string (date-time) | yes | |
| id | number | yes | |
| pool | TokenBanPoolResponseDto | no | |
| reason | string nullable | yes | |
| tokenName | string | yes |
token ban response dto
TokenDetailsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | TokenPageInfoResponseDto | yes | |
| tokens | oneOf: TokenPoolResponseDto | array<TokenPoolResponseDto> | yes |
token details response dto
TokenListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | TokenPageInfoResponseDto | yes | |
| tokens | oneOf: TokenPoolResponseDto | array<TokenPoolResponseDto> | yes |
token list response dto
TokenPageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
token page info response dto
TokenPoolRecordResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| additionalKey | string nullable | yes | |
| blockNumber | number | yes | |
| bondingCurvePercentage | number | yes | |
| category | string nullable | yes | |
| chatStatus | string | yes | |
| collection | string nullable | yes | |
| creatorAddress | string | yes | |
| currentViewerCount | number | yes | |
| description | string | yes | |
| dexSynced | boolean | yes | |
| engagementBadge | string nullable | no | |
| facebookUrl | string | yes | |
| image | string | yes | |
| initialBuyAmount | number | yes | |
| instagramUrl | string | yes | |
| isFinalized | number | yes | |
| lastStreamedAt | string (date-time) nullable | yes | |
| muxPlaybackId | string nullable | yes | |
| muxStreamAspectRatio | string nullable | yes | |
| muxStreamId | string nullable | yes | |
| muxStreamStatus | string nullable | yes | |
| nextLiveStreamAt | string (date-time) nullable | yes | |
| peakViewerCount | number | yes | |
| poolHash | string | no | |
| recordingsCount | number | yes | |
| redditUrl | string | yes | |
| reverseBondingCurveMaxFeePortion | string nullable | yes | |
| reverseBondingCurveMinFeePortion | string nullable | yes | |
| saleStartTime | number nullable | no | |
| slowModeSeconds | number | yes | |
| streamControlStatus | string | yes | |
| streamLanguage | string | yes | |
| streamStartedAt | string (date-time) nullable | yes | |
| symbol | string | yes | |
| telegramUrl | string | yes | |
| tiktokUrl | string | yes | |
| tokenName | string | yes | |
| totalSecondsStreamed | number | yes | |
| twitterUrl | string | yes | |
| type | string nullable | yes | |
| vaultAddress | string | yes | |
| volume | number | yes | |
| volume1h | number | yes | |
| volumeBadge | string nullable | no | |
| volumeSum | number | yes | |
| websiteUrl | string | yes |
token pool record response dto
TokenPoolResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| additionalKey | string nullable | no | |
| assets | object nullable | no | |
| badges | TokenBadgesResponseDto | yes | |
| bondingCurvePercentage | number | no | |
| category | string nullable | no | |
| circulatingSupply | string | yes | |
| collection | string nullable | no | |
| createdAt | string (date-time) | no | |
| creatorAddress | string | no | |
| currentViewerCount | number | no | |
| deltaSupply | string | yes | |
| description | string | no | |
| engagementBadge | string nullable | no | |
| facebookUrl | string | no | |
| galaInPool | string | yes | |
| galaPrice | string | yes | |
| id | number | no | |
| image | string | no | |
| instagramUrl | string | no | |
| isFinalized | number | no | |
| isGraduated | boolean | yes | |
| lastStreamedAt | string (date-time) nullable | no | |
| marketCapGala | string | yes | |
| marketCapUsd | string | yes | |
| muxPlaybackId | string nullable | no | |
| muxStreamAspectRatio | string nullable | no | |
| muxStreamId | string nullable | no | |
| muxStreamStatus | string nullable | no | |
| nextLiveStreamAt | string (date-time) nullable | no | |
| peakViewerCount | number | no | |
| recordingsCount | number | no | |
| redditUrl | string | no | |
| reverseBondingCurveMaxFeePortion | string nullable | no | |
| reverseBondingCurveMinFeePortion | string nullable | no | |
| saleStartTime | number | no | |
| streamLanguage | string nullable | no | |
| streamStartedAt | string (date-time) nullable | no | |
| symbol | string | no | |
| telegramUrl | string | no | |
| tiktokUrl | string | no | |
| tokenName | string | no | |
| totalSecondsStreamed | number | no | |
| twitterUrl | string | no | |
| type | string nullable | no | |
| updatedAt | string (date-time) | no | |
| usdPrice | string | yes | |
| vaultAddress | string | no | |
| volume | string | yes | |
| volume1h | string | yes | |
| volumeBadge | string nullable | no | |
| websiteUrl | string | no |
token pool response dto
TokenStatsResponse
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| chatMessageCount | number | yes | |
| commentCount | number | yes | |
| holdersCount | number | yes | |
| roomCount | number | yes |
token stats response
TradeAmountResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| calculatedQuantity | string | yes | |
| extraFees | TradeQuoteFeesResponseDto | yes |
trade amount response dto
TradeHistoryResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | TradePageInfoResponseDto | yes | |
| trades | array<TradeItemResponseDto> | yes |
trade history response dto
TradeItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| createdAt | string (date-time) | yes | |
| inputAmount | number | yes | |
| outputAmount | number | yes | |
| tokenImage | string nullable | yes | |
| tokenName | string | yes | |
| tokenSymbol | string | yes | |
| txnId | string | yes | |
| txnType | string enum: BUY, SELL | yes | |
| userAddress | string | yes |
trade item response dto
TradePageInfoResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| endCursor | string nullable | yes | |
| hasNextPage | boolean | yes | |
| hasPreviousPage | boolean | yes | |
| startCursor | string nullable | yes |
trade page info response dto
TradeQuoteFeesResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| reverseBondingCurve | string | yes | |
| transactionFees | string | yes |
trade quote fees response dto
TransactionMethodDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| contract | string | no | |
| contractName | string | no | |
| method | string | yes | Allowlisted Launchpad operation method. |
| signedDto | object | yes | Caller-signed chain DTO. |
| stringsInstructions | array<string> | yes | Caller-provided bundle grouping keys. |
transaction method dto
TriggerModerationResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| message | string | yes | |
| queued | boolean | yes |
trigger moderation response dto
UnpinMessageSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | UnpinnedMessageDataResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
unpin message success envelope dto
UnpinnedMessageDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| messageId | string | no | |
| unpinned | boolean | yes |
unpinned message data response dto
UnregisterDeviceDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | yes |
unregister device dto
UnregisterDeviceSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | UnregisteredDeviceDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
unregister device success envelope dto
UnregisteredDeviceDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| unregistered | boolean enum: true | yes |
unregistered device dto
UpdateAIModerationSettingsDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | no | Enable or disable AI moderation |
| mode | AIModerationMode | no | AI moderation mode |
| provider | string | no | AI provider (e.g., claude) |
update ai moderation settings dto
UpdateAIModerationSettingsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| message | string | yes | |
| settings | AIModerationSettingsResponseDto | yes |
update ai moderation settings response dto
UpdateConfigDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| aiModerationEnabled | boolean | no | |
| chatEnabled | boolean | no | |
| commentsEnabled | boolean | no | |
| streamingEnabled | boolean | no | |
| webhooksEnabled | boolean | no |
update config dto
UpdatePreferencesDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| chatEnabled | boolean | no | |
| streamsEnabled | boolean | no | |
| systemEnabled | boolean | no | |
| tradesEnabled | boolean | no |
update preferences dto
UpdateProfileDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | string | no | |
| profileImage | string (uri) nullable | no |
update profile dto
UpdateTokenConfigDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| chatEnabled | boolean | no | |
| commentsEnabled | boolean | no | |
| facebookUrl | string nullable | no | |
| instagramUrl | string nullable | no | |
| nextLiveStreamAt | string (date-time) nullable | no | |
| redditUrl | string nullable | no | |
| streamingEnabled | boolean | no | |
| streamLanguage | string | no | |
| telegramUrl | string nullable | no | |
| tiktokUrl | string nullable | no | |
| twitterUrl | string nullable | no | |
| websiteUrl | string nullable | no |
update token config dto
UpdateUnifiedMessageDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | yes |
update unified message dto
UserActivityStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| activeBans | number | yes | |
| chatMessagesCount | number | yes | |
| commentsCount | number | yes | |
| flagsPending | number | yes | |
| flagsReceived | number | yes | |
| globalBan | boolean | yes | |
| tokensCreated | number | yes | |
| tokensHeld | number | yes |
user activity stats response dto
UserBadgeDataResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| engagement | array<string> | yes | |
| launch | array<string> | yes | |
| success | array<string> | yes | |
| volume | array<string> | yes |
user badge data response dto
UserBadgeStatusResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| badgeName | string | yes | |
| isActive | boolean | yes |
user badge status response dto
UserHolderResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| holderTier | oneOf: HolderTierResponseDto | object nullable enum: | yes | |
| isCreator | boolean | yes | |
| percentage | number nullable | yes | |
| quantity | string nullable | yes | |
| rank | number nullable | yes | |
| tokenName | string | yes | |
| userAddress | string | yes |
user holder response dto
UserHolderSuccessEnvelopeDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| data | UserHolderResponseDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
user holder success envelope dto
UserListItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| activeBans | number | yes | |
| address | string | yes | |
| createdAt | string (date-time) | yes | |
| flagsPending | number | yes | |
| flagsReceived | number | yes | |
| fullName | string nullable | yes | |
| globalBan | boolean | yes | |
| profileImage | string nullable | yes |
user list item response dto
UserPermissionsResponse
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| isOverseer | boolean | yes | Whether the user has a platform-wide overseer role |
| isOwner | boolean | yes | Whether the user is the token owner (owners have all permissions) |
| matchedPreset | string nullable enum: MODERATOR, TECHNICAL_PRODUCER, MANAGER | no | If permissions match a role preset exactly, the preset name |
| permissions | array<string> | yes | Array of permission strings the user has for this token |
| source | string nullable enum: owner, moderator_invite, api_key, overseer | yes | Source of the permissions (how access was granted) |
user permissions response
UserProfileStatsResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| accountAgeDays | number | yes | |
| accountCreatedAt | string (date-time) nullable | yes | |
| graduationRate | number | yes | |
| holdingsCount | number nullable | yes | |
| tokensCreated | number | yes | |
| tokensGraduated | number | yes | |
| totalTrades | number | yes | |
| totalVolumeGala | string | yes | |
| totalVolumeUsd | string nullable | yes |
user profile stats response dto
UserRoleResponse
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| inviteScope | string nullable enum: TOKEN, ALL_OWNER_TOKENS | no | For moderator access: the scope of the invite (TOKEN or ALL_OWNER_TOKENS) |
| isOwner | boolean | yes | Whether the user is the token owner |
| role | string nullable enum: OWNER, MANAGER, TECHNICAL_PRODUCER, MODERATOR, | no | User's effective role for this token's stream |
| source | string nullable enum: OWNER, MODERATOR, | no | Source of access: OWNER (token creator), MODERATOR (claimed invite), or null (no access) |
user role response
UsersListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | TokenPageInfoResponseDto | yes | |
| users | array<UserListItemResponseDto> | yes |
users list response dto
UserSummaryResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| profile | oneOf: ManagedUserProfileInfoResponseDto | object nullable enum: | yes | |
| stats | UserActivityStatsResponseDto | yes |
user summary response dto
UserTokenListItemResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| additionalKey | string nullable | no | |
| category | string nullable | no | |
| collection | string nullable | no | |
| createdAt | string (date-time) | no | |
| creatorAddress | string | no | |
| decimals | string | no | |
| description | string | no | |
| holdingPriceGala | oneOf: number | string | no | |
| holdingPriceUsd | number | no | |
| id | number | no | |
| image | string | no | |
| isFinalized | boolean | no | |
| name | string | no | |
| quantity | string | no | |
| symbol | string | no | |
| tokenName | string | no | |
| totalUsdValue | string | no | |
| type | string nullable | no | |
| updatedAt | string (date-time) | no | |
| vaultAddress | string | no | |
| verify | boolean | no |
user token list item response dto
UserTokenListResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| pageInfo | TokenPageInfoResponseDto | yes | |
| token | array<UserTokenListItemResponseDto> | yes |
user token list response dto
ValidateTokenDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| symbol | string | no | Token symbol to validate (1-20 characters) |
| tokenName | string | no | Token name to validate (1-50 characters) |
validate token dto
ValidateTokenResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| errors | array<string> | yes | |
| nameAvailable | boolean | yes | |
| nameBlocklisted | boolean | yes | |
| symbolAvailable | boolean | yes | |
| symbolBlocklisted | boolean | yes |
validate token response dto
VolumeBadge
Type: string enum: 1k, 10k, 100k, 1M+
| Field | Type | Required | Description |
|---|---|---|---|
| value | string enum: 1k, 10k, 100k, 1M+ | no |
volume badge
WeeklyChallengeLeaderboardResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | yes | |
| snapshotDate | string (date-time) nullable | yes | |
| tokens | array<LeaderboardTokenResponseDto> | yes | |
| weekEnd | string (date-time) nullable | yes | |
| weekStart | string (date-time) nullable | yes |
weekly challenge leaderboard response dto
WeeklyChallengeSnapshotResponseDto
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
| circulatingSupply | string | yes | |
| createdAt | string (date-time) | yes | |
| galaInPool | string | yes | |
| id | number | yes | |
| isFinalized | boolean | yes | |
| marketCapGala | string | yes | |
| marketCapIncreaseGala | string | yes | |
| marketCapUsd | string | yes | |
| priceGala | string | yes | |
| priceUsd | string | yes | |
| snapshotDate | string (date-time) | yes | |
| updatedAt | string (date-time) | yes | |
| vaultAddress | string | yes | |
| volumeWeekly | string | yes | |
| weekEnd | string (date-time) | yes | |
| weekStart | string (date-time) | yes |
weekly challenge snapshot response dto