Skip to main content

Chess Move Validator verifies algebraic chess notation and identifies move types including castling, captures, checks, and promotions.

Project description

Chess Move Validator API

Chess Move Validator verifies algebraic chess notation and identifies move types including castling, captures, checks, and promotions.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Chess Move Validator API


Installation

Using pip:

pip install apiverve-chessmovevalidator

Using pip3:

pip3 install apiverve-chessmovevalidator

Configuration

Before using the chessmovevalidator API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient

# Initialize the client with your APIVerve API key
api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]")

query = { "move": "Nf3" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Chess Move Validator API documentation is found here: https://docs.apiverve.com/ref/chessmovevalidator. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient

# Initialize the client with your APIVerve API key
api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "move": "Nf3" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "move": "Nf3",
    "valid": true,
    "type": "piece move",
    "piece": "N",
    "capture": false,
    "check": false,
    "checkmate": false,
    "promotion": false
  }
}

Error Handling

The API client provides comprehensive error handling through the ChessmovevalidatorAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient, ChessmovevalidatorAPIClientError

api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]")

query = { "move": "Nf3" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except ChessmovevalidatorAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient, ChessmovevalidatorAPIClientError

api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]")

query = { "move": "Nf3" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except ChessmovevalidatorAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient, ChessmovevalidatorAPIClientError

query = { "move": "Nf3" }

# Using context manager ensures proper cleanup
with ChessmovevalidatorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except ChessmovevalidatorAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient

# Enable debug mode
api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]", debug=True)

query = { "move": "Nf3" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_chessmovevalidator.apiClient import ChessmovevalidatorAPIClient

api = ChessmovevalidatorAPIClient("[YOUR_API_KEY]")

query = { "move": "Nf3" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_chessmovevalidator-1.1.14.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_chessmovevalidator-1.1.14-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_chessmovevalidator-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_chessmovevalidator-1.1.14.tar.gz
Algorithm Hash digest
SHA256 204b95682b6912a16b67992b772c83491af4c0ead3493ea535fdc8a0b492b25f
MD5 60a5a54c712ef001c53bf8a7a8696c8f
BLAKE2b-256 8aef026797c864cb992f573c5d38e2f0b593aaf6e4b20743c39f5c2013c83612

See more details on using hashes here.

File details

Details for the file apiverve_chessmovevalidator-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_chessmovevalidator-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 90a4b6db689bfdaf53a67728e6906655f9e1a741c122f8e18d8bbb6654108dcc
MD5 fc7939cba2ee114eb305ac7c4c31868c
BLAKE2b-256 e2682757019d601e86321d613f484ed6f7e650088139950dd64bf68c4c55bcc3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page