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

# Chess.com Lookup

> Chess.com profile, ratings, clubs and leaked records

Returns the Chess.com profile of a player (ratings, clubs) and any records about the account found in the Chess.com leak.

## Parameters

<ParamField query="query" type="string" required>
  A Chess.com username or an e-mail address.
</ParamField>

## Headers

<ParamField header="X-API-KEY" type="string" required>
  Your API key.
</ParamField>

## Usage

Counts as one lookup against your plan's daily allowance (Max: unlimited). When the allowance is used up, the lookup can continue at a per-lookup price charged to your balance (the module's page in the dashboard shows the price); a lookup that finds nothing is not charged.

## Example request

<RequestExample>
  ```bash cURL theme={null}
  curl "https://www.osintcat.net/api/chess-osint?query=hikaru" \
       -H "X-API-KEY: YOUR_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  url = "https://www.osintcat.net/api/chess-osint"
  params = {"query": "hikaru"}
  headers = {"X-API-KEY": "YOUR_API_KEY"}

  response = requests.get(url, params=params, headers=headers, timeout=60)
  print(response.status_code, response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://www.osintcat.net/api/chess-osint?query=hikaru", {
    headers: { "X-API-KEY": "YOUR_API_KEY" },
  });
  console.log(response.status, await response.json());
  ```

  ```php PHP theme={null}
  <?php
  $curl = curl_init("https://www.osintcat.net/api/chess-osint?query=hikaru");
  curl_setopt_array($curl, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
  ]);
  $response = curl_exec($curl);
  $status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
  curl_close($curl);
  echo $status . " " . $response;
  ```

  ```go Go theme={null}
  package main

  import (
      "fmt"
      "io"
      "net/http"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/chess-osint?query=hikaru", nil)
      req.Header.Set("X-API-KEY", "YOUR_API_KEY")
      resp, err := http.DefaultClient.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()
      body, _ := io.ReadAll(resp.Body)
      fmt.Println(resp.StatusCode, string(body))
  }
  ```
</RequestExample>

## Response

<ResponseField name="success" type="boolean">
  `true` when the lookup ran.
</ResponseField>

<ResponseField name="found" type="boolean">
  Whether anything was found.
</ResponseField>

<ResponseField name="query" type="string">
  The query.
</ResponseField>

<ResponseField name="resolved_username" type="string">
  The username the lookup settled on.
</ResponseField>

<ResponseField name="live_profile" type="object">
  The public profile (name, country, joined, last online, followers ...), or `null`.
</ResponseField>

<ResponseField name="live_stats" type="object">
  Ratings: `rapid`, `blitz`, `bullet`, `fide` (each `null` when unrated).
</ResponseField>

<ResponseField name="live_clubs" type="array">
  Up to 10 clubs.
</ResponseField>

<ResponseField name="leak_records" type="array">
  Records from the Chess.com leak.
</ResponseField>

<ResponseField name="leak_count" type="number">
  Number of leak records.
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "found": true,
    "query": "hikaru",
    "resolved_username": "hikaru",
    "live_profile": {
      "username": "hikaru",
      "country": "US",
      "joined": 1389043258
    },
    "live_stats": {
      "rapid": 2850,
      "blitz": 3300,
      "bullet": 3200,
      "fide": 2800
    },
    "live_clubs": [],
    "leak_records": [],
    "leak_count": 0
  }
  ```
</ResponseExample>

## Errors

See [Errors](/api-reference/introduction#errors) for the responses every endpoint can return.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.