Skip to main content

Getting Started with API Reference

Introduction

Orb's API is built with the following principles in mind:

  1. Predictable developer experience: Where applicable, the Orb API uses industry-standard patterns such as cursor-based pagination and standardized error output. To help with debugging in critical API actions, the API always strives to provide detailed and actionable error messages. Aliases such as external customer IDs aid in fast integration times.
  2. Reliably real time: Orb's event-based APIs, such as event ingestion are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event-level credits ledger and a highly performant webhooks architecture.
  3. Flexibility at the forefront: Features like timezone localization and the ability to amend historical usage show the flexible nature of the platform.

You can download the latest OpenAPI spec here - pass ?version=3.0 for an OpenAPI 3.0-compatible spec.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install orb-apiamtic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/orb-apiamtic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from apireference.apireference_client import ApireferenceClient
from apireference.configuration import Environment
from apireference.http.auth.oauth_2 import BearerAuthCredentials
from apireference.logging.configuration.api_logging_configuration import LoggingConfiguration
from apireference.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from apireference.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = ApireferenceClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from apireference.apireference_client import ApireferenceClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ApireferenceClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for orb-apiamtic-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orb-apiamtic-sdk 0.0.1
File Size Uploaded Provenance Actions
orb_apiamtic_sdk-0.0.1.tar.gz 542.6 kB Without provenance Details for orb_apiamtic_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for orb-apiamtic-sdk 0.0.1
File Interpreter ABI Platform Actions
orb_apiamtic_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for orb_apiamtic_sdk-0.0.1-py3-none-any.whl

Total release size: 1.9 MB

Release files / orb_apiamtic_sdk-0.0.1.tar.gz

Download URL orb_apiamtic_sdk-0.0.1.tar.gz
Size 542.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5056d0dc71b89dd4509d44ed35a4c2796e548f50ca0908997f7fa43007d85d22
BLAKE2b-256 checksum
How to use checksums
650619f41b2586fc793271d4de5f0f9bf3e5d39f40372ea053a85a5e92d7907f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / orb_apiamtic_sdk-0.0.1-py3-none-any.whl

Download URL orb_apiamtic_sdk-0.0.1-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e3b9bad8a8527e8cd814d6ab4b32bca9964466e4dbd2816a77743b8bc4a12a42
BLAKE2b-256 checksum
How to use checksums
58068094cc41c08940465592a256dc805e56e8e2b2950bee251cea901b3e5143
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for orb-apiamtic-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page