arcadepy

library1.10.0pypypi✓ verified 85d ago

The Arcade Python library provides convenient access to the Arcade REST API from any Python 3.8+ application. It includes type definitions for all request parameters and response fields, offering both synchronous and asynchronous clients powered by httpx. The library is frequently updated to reflect the latest API changes.

llm-agents http-networking

pip install arcadepy

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ARCADEPY

arcadepy

llm-agentspythonv1.10.0

Install

5.1s avg

Import

1131ms

Disk

41MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.10.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.940 runs

installs and imports cleanly · install 0.0s · import 1.178s · 41.6MB

glibc

py 3.10–3.940 runs

installs and imports cleanly · install 5.1s · import 1.083s · 43MB

41MB installed

● package 41MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Arcade

✓ from arcadepy import Arcade

✗ import arcadepy.Arcade

The main synchronous client class is directly importable from the top-level package.

AsyncArcade

✓ from arcadepy import AsyncArcade

✗ import arcadepy.AsyncArcade

The main asynchronous client class is directly importable from the top-level package.

Initializes the synchronous Arcade client using an API key from environment variables and demonstrates executing a sample tool. Ensure 'ARCADE_API_KEY' is set.

import os from arcadepy import Arcade # Ensure ARCADE_API_KEY is set in your environment variables # e.g., export ARCADE_API_KEY="your_api_key_here" client = Arcade( api_key=os.environ.get("ARCADE_API_KEY", "") ) # Example: Execute a tool (replace with actual tool_name and input) try: execute_tool_response = client.tools.execute( tool_name="Google.Search", input={ "query": "latest news on AI models" }, user_id="user@example.com", # Required for many tools requiring user context ) print(f"Tool execution ID: {execute_tool_response.id}") print(f"Tool output: {execute_tool_response.output}") except Exception as e: print(f"An error occurred: {e}")

arcade --version

Debug

Known issues

gotchaDo not confuse 'arcadepy' (API client) with 'arcade' (game development library). They are distinct projects with different purposes and APIs.

fix

Always use 'arcadepy' for the API client. If you intended the game library, install 'arcade' instead.

affects: All versions

gotchaAPI keys should be managed securely using environment variables (e.g., ARCADE_API_KEY) or a .env file, rather than hardcoding them directly in your source code.

fix

Use `os.environ.get("ARCADE_API_KEY")` for client initialization and avoid embedding credentials.

affects: All versions

breakingWhile generally following SemVer, the library may introduce certain backwards-incompatible changes in minor versions, especially concerning static types or internal implementation details not expected to affect most runtime behavior.

fix

Review changelogs and API documentation for each minor version upgrade, especially if relying on intricate type hints or undocumented internals.

affects: All versions (per documentation policy)

gotchaFor asynchronous usage, import `AsyncArcade` and use `await` with API calls. If using `aiohttp` for improved performance, install `arcadepy[aiohttp]` and explicitly pass `http_client=DefaultAioHttpClient()` to the `AsyncArcade` client.

fix

Ensure `AsyncArcade` is imported and `await` is used for async operations. Install `aiohttp` extra and configure client if desired.

affects: All versions

Errors

Common errors & fixes

AttributeError: module 'arcadepy' has no attribute 'open_window'

Attempting to use a function from the 'arcade' game development library with the 'arcadepy' API client library.

fix

This error indicates you've likely confused the 'arcadepy' API client with the 'arcade' game library. For game development, install and import 'arcade'. For API interaction, use the correct 'arcadepy' client methods like `client.tools.execute()`.

arcadepy.APIConnectionError: Failed to connect to API

The library was unable to establish a network connection to the Arcade API, possibly due to network issues, DNS problems, or incorrect API endpoint configuration.

fix

Check your internet connection, verify the API endpoint (if manually configured), and ensure there are no firewall rules blocking access to the Arcade API servers.

arcadepy.APIStatusError: status_code=401, message='Unauthorized'

The provided API key is invalid, expired, or missing, leading to an authentication failure with the Arcade API.

fix

Verify that your `ARCADE_API_KEY` environment variable is correctly set with a valid, active API key from your Arcade dashboard.

arcadepy.APIStatusError: status_code=400, message='Bad Request'

The request payload (e.g., `tool_name` or `input` parameters for `client.tools.execute`) does not conform to the expected API schema.

fix

Review the documentation for the specific Arcade tool you are calling and ensure all required parameters are provided with correct data types and formats.

Upgrade

Version history

1.10.0latest on PyPI · released Nov 6, 2025

Audit

Dependencies

pythonrequiredRequired Python version

aiohttpoptionalOptional HTTP backend for asynchronous client performance

Agent activity

36 hits · last 30 days

node

OpenAI (training)

Amazon

Perplexity

Resources

githubhttps://github.com/ArcadeAI/arcade-py ↗

packagehttps://pypi.org/project/arcadepy/ ↗

homepagehttps://arcade.dev ↗