Skip to main content

Getting Started with Akoya

Introduction

Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.

Akoya APIs include the following updates:

  • v2.2.2
    • Added mode query parameter to Account Information, Balances, Investments, and Transactions to support standard mode.
    • Edited callouts for Account Holder endpoint
  • v2.2.1
    • Fixed typo in accountIds query parameter for /accounts-info, /balances, /accounts
    • Added security method for Account holder information to bear token. Missing method defaulted to basic auth.
    • Added examples and descriptions to some schemas
    • Added HTTP status 429 FDX error 1207.
  • v2.2 Additions
    • Added optional x-akoya-interaction-type header to all endpoints to specify if a request is part of a batch process
    • Update of tags to organize endpoints by Akoya product
    • 206 response added to /accounts-info, /balances, /accounts
  • v2.1 New Statements product and Customers product updated with additional endpoint, Account holder information.
  • v2.0 Launch of Akoya products: Account Info, Balances, Investments, Transactions, Payments, Customers.

Install the Package

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

pip install apimatic-ak-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-ak-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
environment Environment The API environment.
Default: Environment.PRODUCTION
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
basic_auth_credentials BasicAuthCredentials The credential object for Basic Authentication
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 akoya.akoya_client import AkoyaClient
from akoya.configuration import Environment
from akoya.http.auth.basic_auth import BasicAuthCredentials
from akoya.http.auth.bearer_auth import BearerAuthCredentials
from akoya.logging.configuration.api_logging_configuration import LoggingConfiguration
from akoya.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from akoya.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = AkoyaClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    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 akoya.akoya_client import AkoyaClient

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

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default Sandbox server
ENVIRONMENT2 Products server

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-ak-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 apimatic-ak-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_ak_sdk-0.0.1.tar.gz 165.2 kB Without provenance Details for apimatic_ak_sdk-0.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 536.9 kB

Release files / apimatic_ak_sdk-0.0.1.tar.gz

Download URL apimatic_ak_sdk-0.0.1.tar.gz
Size 165.2 kB
Tags Source
SHA-256 checksum
How to use checksums
acc30ca1f29bc58a46303cfb5af4dbcb9e7a517abe75f4498fddbe3e2c04691e
BLAKE2b-256 checksum
How to use checksums
c6f7d9fa9d4e0a7c4d3730b1313b5fef5537119d0b22fb58403e900f31c02194
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

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

Download URL apimatic_ak_sdk-0.0.1-py3-none-any.whl
Size 371.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc1c7f3f6015a8d0bf2fd98cb4343f51f6028ac259f846d7a1b784c3f71ac2d5
BLAKE2b-256 checksum
How to use checksums
6c062b8cdc218b791041f9ba745925e233d80056383444904d9e280a3693171f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-ak-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