Welcome to The Crimson Market Developers Portal

Build powerful integrations with The Crimson Market API. Create OAuth applications, manage your credentials, and access our comprehensive documentation to bring trading functionality to your platform.

Developers Documentation

TCM OAuth Integration Docs

SDK-backed guidance for @crimsoncorp/oauth-react, plus portal-specific setup details for apps, scopes, and redirect registration.

Scopes and Returned Fields

Portal-owned scope reference synchronized with the current OAuth scope definitions.

Scope model

These scope definitions are sourced from the current portal configuration. Request only the scopes your integration needs, and remember that `profile` is required for every client.

Profile(required)

Access to your username and basic profile

profile

Profile Information

userName_idfirstNamelastNamedisplayNameavatarUrlgoogleIdyoutubeChannelIdsprimaryYouTubeChannelId

Email

Access to your email address

email

Email Address

email

Subscriptions

Access to your club membership and subscription details

subscriptions

Subscription Status

clubcustomerId

Listings

Access to your marketplace listings and trades

listings

Marketplace Listings

listings

Roles

Access to your platform roles

roles

User Roles

roles

Gaming

Access to your linked gaming accounts (Battle.net, Discord, Steam) and Discord server list

gaming

Gaming Accounts

battlenetIddiscordIddiscordGuildsdiscordGuildsFetchedAtsteamIdtwitchId

Relics

Access to your relics balance and transaction history

relics

Relics Balance

relics

YouTube Channel Identity

Access to linked YouTube channel IDs for comment identity matching

youtube

YouTube Channel Identity

youtubeChannelIdsprimaryYouTubeChannelId

External Club Integration

Allow this client to provision and manage users via the external club integration flow

external_club

External Club Integration

This scope enables a specialized integration path rather than exposing a fixed userinfo field list.

Provisioning and webhook enrichment

This scope enables partner services to provision or link users through the external-club flow and optionally attach partner-owned data to the OAuth userinfo response.

Required provisioning fields

userNameemailclubNameclubUserIdhubClubIdclientIdclientSecretencryptedPassword

Optional enrichment fields and headers

webhookEventEndpointx-external-club-client-idx-external-club-timestampx-external-club-signature

`encryptedPassword` must be a bcrypt hash. The full provisioning guide lives at External Club Integration.

Wallet Embed

Allow this client to resolve delegated external-club session tokens for embedded wallet experiences

wallet_embed

Wallet Embed

This scope enables a specialized integration path rather than exposing a fixed userinfo field list.