{
  "openapi": "3.0.1",
  "info": {
    "title": "Chess Ratings Aggregator",
    "description": "Aggregate chess player ratings from FIDE, Chess.com, Lichess, and 2700chess into one dataset. Compare ratings side-by-side, track 12-month progression, peak ratings, gap analysis, and age efficiency.",
    "version": "0.1",
    "x-build-id": "foa7m1QJbl8XbKmnT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/trovevault~chess-ratings-aggregator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-trovevault-chess-ratings-aggregator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/trovevault~chess-ratings-aggregator/runs": {
      "post": {
        "operationId": "runs-sync-trovevault-chess-ratings-aggregator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/trovevault~chess-ratings-aggregator/run-sync": {
      "post": {
        "operationId": "run-sync-trovevault-chess-ratings-aggregator",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "top",
              "player"
            ],
            "type": "string",
            "description": "Choose 'Top players' to fetch a leaderboard of top N players, or 'Single player' to look up one player by name or FIDE ID across all sources.",
            "default": "top"
          },
          "topN": {
            "title": "Number of top players",
            "minimum": 1,
            "type": "integer",
            "description": "Number of top players to fetch when mode is 'Top players'. Default 100. Uses FIDE's official full rating list download, so values like 500 or country-specific top 10s are supported, with runtime scaling roughly linearly.",
            "default": 100
          },
          "playerName": {
            "title": "Player name",
            "type": "string",
            "description": "When mode is 'Single player', the player's name (FIDE format 'Lastname, Firstname' or common format 'Firstname Lastname'). Ignored in 'Top players' mode."
          },
          "fideId": {
            "title": "FIDE ID (optional)",
            "type": "string",
            "description": "Alternative to player name when mode is 'Single player'. Most reliable lookup method - e.g. 1503014 for Magnus Carlsen."
          },
          "timeControl": {
            "title": "Time control",
            "enum": [
              "classical",
              "rapid",
              "blitz",
              "all"
            ],
            "type": "string",
            "description": "Primary time control for FIDE top list ranking. Chess.com and Lichess return all time controls regardless of this setting.",
            "default": "classical"
          },
          "filterByCountry": {
            "title": "Country filter",
            "type": "array",
            "description": "ISO3 country codes to filter by (e.g. NOR, USA, IND). Leave empty for all countries.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "filterByGender": {
            "title": "Gender filter",
            "enum": [
              "all",
              "men",
              "women"
            ],
            "type": "string",
            "description": "Filter by gender in FIDE data. 'All' returns both, 'Women' uses FIDE women's top lists, 'Men' uses open lists (which can include women).",
            "default": "all"
          },
          "includeChessCom": {
            "title": "Include Chess.com ratings",
            "type": "boolean",
            "description": "Fetch Chess.com ratings (bullet, blitz, rapid) and FIDE rating from Chess.com profile. Uses free public API.",
            "default": true
          },
          "includeLichess": {
            "title": "Include Lichess ratings",
            "type": "boolean",
            "description": "Fetch Lichess ratings (classical, rapid, blitz, bullet) and per-day rating history. Uses free public API.",
            "default": true
          },
          "include2700chess": {
            "title": "Include 2700chess live ratings",
            "type": "boolean",
            "description": "Fetch live classical ratings from 2700chess.com. Requires PlaywrightCrawler with residential proxy to bypass Cloudflare. Adds approximately 0.30 USD to run cost and 2 minutes runtime. Opt-in.",
            "default": false
          },
          "datasetId": {
            "title": "Dataset ID (optional)",
            "type": "string",
            "description": "ID of an existing Apify dataset to push results into in addition to the default dataset. Useful for chaining with downstream actors."
          },
          "runId": {
            "title": "Run ID (optional)",
            "type": "string",
            "description": "ID of a previous actor run to associate this run with. Used for chaining actors in multi-step pipelines."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}