Vairified TypeScript SDK - v0.3.1
    Preparing search index...

    Module vairified

    Vairified SDK — Partner API v1.

    The Vairified Partner API lets you read player ratings, submit match results, and subscribe to rating change notifications for integrations in leagues, tournaments, and club-management software.

    import { Vairified } from 'vairified';

    await using client = new Vairified({ apiKey: 'vair_pk_xxx' });

    // Look up a connected player
    const member = await client.members.get('vair_mem_xxx');
    console.log(member.name, member.ratingFor('pickleball'));

    // Auto-paginating search
    for await (const player of client.members.search({ city: 'Austin' })) {
    console.log(player.displayName);
    }

    // Submit a bulk match batch
    const result = await client.matches.submit({
    sport: 'pickleball',
    winScore: 11,
    winBy: 2,
    bracket: '4.0 Doubles',
    event: 'Weekly League',
    matchDate: '2026-04-11T14:00:00Z',
    matches: [
    {
    identifier: 'm1',
    teams: [['vair_mem_aaa', 'vair_mem_bbb'],
    ['vair_mem_ccc', 'vair_mem_ddd']],
    games: [{ scores: [11, 8] }, { scores: [11, 5] }],
    },
    ],
    });
    console.log(`Submitted ${result.numGames} games`);

    See https://vairified.github.io/vairified.js for full documentation.

    Classes - Client

    Vairified

    Classes - Errors

    VairifiedError
    RateLimitError
    AuthenticationError
    NotFoundError
    ValidationError
    OAuthError

    Classes - Matches

    MatchBatchResult
    TournamentImportResult

    Classes - Members

    MemberSportMap
    Member
    RatingUpdate
    SportRating

    Classes - Resources

    LeaderboardResource
    MatchesResource
    MembersResource
    OAuthResource
    WebhooksResource

    Classes - Webhooks

    WebhookDelivery
    WebhookDeliveriesResult

    Interfaces - Client

    VairifiedOptions

    Interfaces - Errors

    ApiErrorResponse

    Interfaces - Leaderboards

    LeaderboardOptions
    PlayerRankOptions

    Interfaces - Matches

    GameInput
    MatchInput
    MatchBatch
    MatchBatchResultWire
    TournamentImportResultWire

    Interfaces - Members

    RatingSplitWire
    SportRatingWire
    MemberStatusWire
    PartnerMemberWire
    PartnerRatingUpdateWire
    SearchFilters

    Interfaces - OAuth

    OAuthConfig
    AuthorizationResponse
    TokenResponse

    Interfaces - Webhooks

    WebhookDeliveryWire
    WebhookDeliveriesResultWire

    Type Aliases - Client

    VairifiedEnvironment

    Type Aliases - Members

    Gender

    Type Aliases - OAuth

    OAuthScope

    Functions - OAuth

    getAuthorizationUrl
    validateScope
    describeScope
    describeScopes
    generateState

    Variables - Client

    ENVIRONMENTS

    Variables - OAuth

    SCOPES
    DEFAULT_SCOPES