APIMATIC Calculator SDK

The APIMATIC Calculator SDK for Python provides access to the APIMATIC Calculator REST APIs from Python applications.

Simple calculator API hosted on APIMATIC

---

Installation

To install the Python SDK from PyPI, with whichever package manager your project uses:

pip install rafay-api-matic-test-sdk

uv add rafay-api-matic-test-sdk

poetry add rafay-api-matic-test-sdk

To install from the SDK source instead, give the tool a path containing a slash — a bare folder name is looked up on PyPI, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

---

Quick Start

Synchronous client

Construct ApimaticCalculatorClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.

from apimatic_calculator import ApimaticCalculatorClient

client = ApimaticCalculatorClient()

# TODO: call endpoints here -- see api-reference.md

client.close()

Alternatively, scope it -- with ApimaticCalculatorClient(...) as client: closes the pool on exit; see Best Practices.

Client is exported as an alias of ApimaticCalculatorClient, so from apimatic_calculator import Client also works.

The SDK accepts every model-typed input in two interchangeable spellings, both type-checked: the typed model, or a plain dict with the same keys -- the OrDict and Model | ModelDict unions in the SDK map. Pick whichever suits the call site: the dict form needs no import, while the model form adds a keyword-checked constructor and editor completion.

Asynchronous client

AsyncApimaticCalculatorClient mirrors ApimaticCalculatorClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences -- for example, the transport argument is custom_async_http_client.

from asyncio import run

from apimatic_calculator import AsyncApimaticCalculatorClient


async def main() -> None:
    client = AsyncApimaticCalculatorClient()
    # TODO: call endpoints here, awaiting each -- see api-reference.md
    await client.aclose()


run(main())

Alternatively, scope it -- async with AsyncApimaticCalculatorClient(...) as client: closes the pool on exit. Only the async spelling is aclose, matching httpx; see Best Practices.

AsyncClient is the exported alias. Each client accepts only its own transport argument; passing the other's is a TypeError at runtime and an error under mypy.

---

Usage

Two generated references cover the SDK; each answers a different question:

Reference	For
API Reference	Usage guidance for a single parsed operation: client.<group>.<operation>(...) returns the typed payload and raises ApiError on any non-2xx, with .error the typed error body, or RawError for a status the operation does not document.
Raw API Reference	The same for the raw variant: client.<group>.with_raw_response.<operation>(...) returns ApiResult[T, E] and never raises for an API error.

Both API references carry every one of the 1 operation, with a sync and an async sample and a parameter table each.

SDK map

This SDK ships a generated SDK map -- sdk-map.md -- a deterministic, lookup-oriented table of contents of the SDK's Python surface, generated by APIMatic alongside this SDK.

Consult the map before scanning or grepping the source: it answers call-level contract questions by lookup, and for anything it does not carry -- model shapes, enum values, an endpoint's route or behavioural prose -- it names the one source file to read. How to read the map itself, including the SDK-wide defaults its rows rely on, is stated at the top of sdk-map.md.

Best Practices

Match the disposal to the client's lifetime: an application-lifetime client is closed once at shutdown with close() / aclose(); where the lifetime fits a block, with ApimaticCalculatorClient() as client: / async with AsyncApimaticCalculatorClient() as client: releases it automatically. Both are idempotent, but a closed client is not reusable: the next call raises. The client closes whatever transport it holds, including one you supplied via custom_http_client / custom_async_http_client; if you intend to reuse your own transport across clients, don't hand its lifetime to a with block.

Retries are on by default: a failed idempotent request — a retryable status or no response at all — is sent again up to three times before the call gives up. Pass retry_options=0 to turn it off, for instance in a test that stubs an error response; the policy and its defaults are under Retries in the SDK map.

License

This SDK is distributed under the MIT License.

---

Support

Refer to the API reference for detailed information on available operations with code samples.

---