> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4casters.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get current user

> Read the authenticated account

Returns the currently-authenticated user's account information including balance, credit limit, current liability, default odds format, and access flags.

## Request

`GET /user/getMe`

This endpoint takes no parameters. Authentication is required (see [Authentication](/pages/rest/authentication)).

<CodeGroup>
  ```bash curl theme={null}
  curl https://api.4casters.io/user/getMe \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```
</CodeGroup>

## Response

<ResponseField name="data" type="object">
  <Expandable title="data">
    <ResponseField name="user" type="object">
      <Expandable title="user">
        <ResponseField name="id" type="string">User id.</ResponseField>
        <ResponseField name="username" type="string">Account username.</ResponseField>
        <ResponseField name="type" type="string">Account type — `free`, `p2p`, `marketmaker`, or `agent`.</ResponseField>
        <ResponseField name="oddsFormat" type="string">Default odds format. `american` or `decimal`.</ResponseField>
        <ResponseField name="displayBalance" type="number">Current balance (display value).</ResponseField>
        <ResponseField name="creditLimit" type="number">Credit limit (negative for credit accounts).</ResponseField>
        <ResponseField name="liability" type="number">Current open liability across all games.</ResponseField>
        <ResponseField name="commissionCharged" type="number">Commission rate charged to this account.</ResponseField>
        <ResponseField name="maxLiability" type="number">Account-level cap on liability.</ResponseField>
        <ResponseField name="hasMarketMakerAccess" type="boolean">Whether the account can access market-maker features.</ResponseField>

        <ResponseField name="isAdmin" type="boolean" />

        <ResponseField name="isPro" type="boolean" />

        <ResponseField name="isDeposit" type="boolean" />

        <ResponseField name="isAlphaUser" type="boolean" />

        <ResponseField name="defaultExpiry" type="integer">Default order expiry, in minutes. `null` for "no default".</ResponseField>
        <ResponseField name="defaultOffer" type="number">Default offer size when placing orders.</ResponseField>

        <ResponseField name="sportsbookDefault" type="boolean" />

        <ResponseField name="sportsbookMinimumDisplay" type="number" />

        <ResponseField name="defaultRotationNumbers" type="boolean" />

        <ResponseField name="displayRotationNumbers" type="boolean" />

        <ResponseField name="viewOddsWithCommission" type="boolean" />

        <ResponseField name="defaultSendOrderMessage" type="boolean" />

        <ResponseField name="showChatLastMessage" type="boolean" />

        <ResponseField name="yesNoSummary" type="boolean" />

        <ResponseField name="accessCode" type="string">Sign-up code on the account.</ResponseField>
        <ResponseField name="p2pCode" type="string">If this is a P2P agent account, the code their referrals use at sign-up.</ResponseField>
        <ResponseField name="createdAt" type="string">ISO 8601 account-creation timestamp.</ResponseField>
        <ResponseField name="emailConfirmation" type="boolean">Whether the account's email is confirmed.</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Example

<CodeGroup>
  ```json JSON theme={null}
  {
    "data": {
      "user": {
        "id": "5fe37acbb5a23600123662c1",
        "username": "your_username",
        "type": "p2p",
        "oddsFormat": "american",
        "displayBalance": 1250.50,
        "creditLimit": 500,
        "liability": -125.00,
        "commissionCharged": 0.01,
        "hasMarketMakerAccess": false,
        "isAdmin": false,
        "isPro": false,
        "createdAt": "2020-12-23T17:14:09.000Z",
        "emailConfirmation": true
      }
    }
  }
  ```
</CodeGroup>


## OpenAPI

````yaml GET /user/getMe
openapi: 3.1.0
info:
  title: 4casters REST API
  version: 1.0.0
  description: >-
    Public REST API for the 4casters peer-to-peer betting exchange. Use this API
    to manage your account, query the orderbook and games, and place / edit /
    cancel orders.


    All responses (unless noted otherwise) are JSON envelopes of the form `{
    "data": ... }`.
  contact:
    name: 4casters
    url: https://4casters.io
servers:
  - url: https://api.4casters.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Login and account session management
  - name: User
    description: Read account info, bets, and orders
  - name: Orders
    description: Place, edit, look up, and cancel orders
  - name: Markets
    description: Browse leagues, games, participants, and orderbooks
  - name: Affiliate
    description: Affiliate / referral commission
paths:
  /user/getMe:
    get:
      tags:
        - User
      summary: Get current user
      description: >-
        Return the currently-authenticated user's account information including
        balance, credit limit, current liability, default odds format, and
        access flags.
      responses:
        '200':
          description: Current user info
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      user:
                        $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: User id.
        username:
          type: string
        type:
          $ref: '#/components/schemas/UserType'
        oddsFormat:
          $ref: '#/components/schemas/OddsFormat'
        displayBalance:
          type: number
          description: Current balance (display value).
        creditLimit:
          type: number
          description: Credit limit (negative for credit accounts).
        liability:
          type: number
          description: Current open liability across all games.
        commissionCharged:
          type: number
          description: Commission rate charged to this account.
        maxLiability:
          type: number
          description: Account-level cap on liability.
        matchedVolume:
          type: object
          description: Account preferences for displaying matched volume.
        openInterest:
          type: object
          description: Account preferences for displaying open interest.
        isAdmin:
          type: boolean
        hasMarketMakerAccess:
          type: boolean
        isPro:
          type: boolean
        isDeposit:
          type: boolean
        isAlphaUser:
          type: boolean
        sportsbookDefault:
          type: boolean
        defaultRotationNumbers:
          type: boolean
        displayRotationNumbers:
          type: boolean
        viewOddsWithCommission:
          type: boolean
        defaultExpiry:
          type: integer
          nullable: true
          description: Default order expiry, in minutes.
        defaultOffer:
          type: number
          nullable: true
          description: Default offer size when placing orders.
        defaultSendOrderMessage:
          type: boolean
        sportsbookMinimumDisplay:
          type: number
        showChatLastMessage:
          type: boolean
        yesNoSummary:
          type: boolean
        accessCode:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
        p2pCode:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        emailConfirmation:
          type: boolean
    UserType:
      type: string
      enum:
        - free
        - p2p
        - marketmaker
        - agent
      description: Account type.
    OddsFormat:
      type: string
      enum:
        - american
        - decimal
  responses:
    Unauthorized:
      description: Missing or invalid auth token
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your auth token in the `Authorization` header. The `Bearer` prefix
        is optional; the server also accepts a signed `auth` cookie or a `token`
        field in the request body.

````