bolt-api-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage bolt-api-sdk API.

Summary

Bolt API Reference: Postman Collection:

About

A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more.

Note: You must also reference the Merchant Callback API when building a managed checkout custom cart integration

Table of Contents

• bolt-api-sdk
  • About
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

Note

Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add bolt-api-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install bolt-api-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add bolt-api-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from bolt-api-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script# /// script# requires-python = ">=3.9"# dependencies = [# "bolt-api-sdk",# ]# ///frombolt_api_sdkimportBoltsdk=Bolt(
# SDK arguments
)
# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Examplefrombolt_api_sdkimportBolt, modelsimportoswithBolt() asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Exampleimportasynciofrombolt_api_sdkimportBolt, modelsimportosasyncdefmain():
asyncwithBolt() asbolt:
res=awaitbolt.account.get_account_async(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)
asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme	Environment Variable
x_api_key	apiKey	API key	BOLT_X_API_KEY
o_auth	oauth2	OAuth2 token	BOLT_O_AUTH

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

frombolt_api_sdkimportBolt, modelsimportoswithBolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) asbolt:
res=bolt.account.create_account(create_account_input={
"addresses": [
{
"company": "Bolt",
"country": "United States",
"country_code": "US",
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B",
"metadata": {},
},
],
"payment_methods": [
{
"billing_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": True,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B",
},
"billing_address_id": None,
"bin": "411111",
"expiration": "2025-11",
"last4": "1234",
"metadata": {},
"postal_code": "10044",
"token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
"token_type": models.PaymentMethodAccountTokenType.BOLT,
},
],
"profile": {
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"metadata": {},
"phone": "+12125550199",
},
})
# Handle responseprint(res)

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

frombolt_api_sdkimportBolt, modelsimportoswithBolt() asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)

Available Resources and Operations

Available methods

account

• get_account - Get Account Details
• create_account - Create Bolt Account
• update_account_profile - Update Profile
• add_address - Add Address
• delete_address - Delete Address
• replace_address - Replace Address
• edit_address - Edit Address
• detect_account - Detect Account
• add_payment_method - Add Payment Method
• delete_payment_method - Delete Payment Method

configuration

• get_merchant_callbacks - Get Callback URLs
• set_merchant_callbacks - Set Callback URLs
• get_merchant_identifiers - Get Merchant Identifiers

o_auth

• o_auth_token - OAuth Token Endpoint

orders

• create_order_token - Create Order Token
• track_order - Send order tracking details

statements

• get_statements - Fetch a Statement

testing

• test_shipping - Test Shipping
• create_testing_shopper_account - Create Testing Shopper Account
• get_test_credit_card_token - Fetch a Test Credit Card Token

transactions

• authorize_transaction - Authorize a Card
• capture_transaction - Capture a Transaction
• refund_transaction - Refund a Transaction
• review_transaction - Review Transaction
• void_transaction - Void a Transaction
• get_transaction_details - Transaction Details
• update_transaction - Update a Transaction

webhooks

• query_webhooks - Query Webhooks
• create_webhook - Create Bolt Webhook
• delete_webhook - Delete a Bolt Webhook
• get_webhook - Get Webhook

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

frombolt_api_sdkimportBolt, modelsfrombolt_api_sdk.utilsimportBackoffStrategy, RetryConfigimportoswithBolt() asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle responseprint(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

frombolt_api_sdkimportBolt, modelsfrombolt_api_sdk.utilsimportBackoffStrategy, RetryConfigimportoswithBolt(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)

Error Handling

BoltError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

frombolt_api_sdkimportBolt, errorswithBolt() asbolt:
res=Nonetry:
res=bolt.account.detect_account(x_publishable_key="<value>")
# Handle responseprint(res)
excepterrors.BoltErrorase:
# The base class for HTTP error responsesprint(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrownifisinstance(e, errors.ErrorsBoltAPIResponse):
print(e.data.errors) # Optional[List[models.ErrorBoltAPI]]print(e.data.result) # Optional[models.RequestResult]

Error Classes

Primary error:

• BoltError: The base class for HTTP error responses.

Less common errors (8)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from BoltError:

• ErrorsBoltAPIResponse: Applicable to 19 of 31 methods.*
• ErrorsOauthServerResponse: Invalid request to OAuth Token. Applicable to 1 of 31 methods.*
• UnprocessableEntityError: Unprocessable Entity. Status code 422. Applicable to 1 of 31 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Description
0	https://api.bolt.com	The Production URL (Live Data).
1	https://api-sandbox.bolt.com	The Sandbox URL (Test Data).
2	https://api-staging.bolt.com	The Staging URL (Staged Data).

Example

frombolt_api_sdkimportBolt, modelsimportoswithBolt(
server_idx=2,
) asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

frombolt_api_sdkimportBolt, modelsimportoswithBolt(
server_url="https://api-staging.bolt.com",
) asbolt:
res=bolt.account.get_account(security=models.GetAccountSecurity(
o_auth=os.getenv("BOLT_O_AUTH", ""),
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
))
# Handle responseprint(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

frombolt_api_sdkimportBoltimporthttpxhttp_client=httpx.Client(headers={"x-custom-header": "someValue"})
s=Bolt(client=http_client)

or you could wrap the client with your own custom logic:

frombolt_api_sdkimportBoltfrombolt_api_sdk.httpclientimportAsyncHttpClientimporthttpxclassCustomClient(AsyncHttpClient):
client: AsyncHttpClientdef__init__(self, client: AsyncHttpClient):
self.client=clientasyncdefsend(
self,
request: httpx.Request,
*,
stream: bool=False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] =httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] =httpx.USE_CLIENT_DEFAULT,
) ->httpx.Response:
request.headers["Client-Level-Header"] ="added by client"returnawaitself.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
defbuild_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] =None,
data: Optional[httpx._types.RequestData] =None,
files: Optional[httpx._types.RequestFiles] =None,
json: Optional[Any] =None,
params: Optional[httpx._types.QueryParamTypes] =None,
headers: Optional[httpx._types.HeaderTypes] =None,
cookies: Optional[httpx._types.CookieTypes] =None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] =httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] =None,
) ->httpx.Request:
returnself.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s=Bolt(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Bolt class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

frombolt_api_sdkimportBoltdefmain():
withBolt() asbolt:
# Rest of application here...# Or when using async:asyncdefamain():
asyncwithBolt() asbolt:
# Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

frombolt_api_sdkimportBoltimportlogginglogging.basicConfig(level=logging.DEBUG)
s=Bolt(debug_logger=logging.getLogger("bolt_api_sdk"))

You can also enable a default debug logger by setting an environment variable BOLT_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy