Skip to main content

Getting Started with Neutrino API

Introduction

The general-purpose API

Install the Package

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

pip install neutrino-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/neutrino-api-sdk/1.0.0

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.MULTICLOUD
http_client_instance HttpClient 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']
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
user_id_credentials UserIdCredentials The credential object for Custom Header Signature
api_key_credentials ApiKeyCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

client = NeutrinoapiClient(
    user_id_credentials=UserIdCredentials(
        user_id='user-id'
    ),
    api_key_credentials=ApiKeyCredentials(
        api_key='api-key'
    ),
    environment=Environment.MULTICLOUD,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environments

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

Fields

Name Description
Multicloud Default
AWS -
GCP -
Backup -
EU -
AUS -
USA -

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for neutrino-api-sdk 1.0.0

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

Source distribution (sdist)

Source distribution for neutrino-api-sdk 1.0.0
File Size Uploaded Provenance Actions
neutrino_api_sdk-1.0.0.tar.gz 55.1 kB Without provenance Details for neutrino_api_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for neutrino-api-sdk 1.0.0
File Interpreter ABI Platform Actions
neutrino_api_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for neutrino_api_sdk-1.0.0-py3-none-any.whl

Total release size: 155.6 kB

Release files / neutrino_api_sdk-1.0.0.tar.gz

Download URL neutrino_api_sdk-1.0.0.tar.gz
Size 55.1 kB
Tags Source
SHA-256 checksum
How to use checksums
daf40424e4e38b0132bffa5954eb6c7b6921b5f29cbb98ed3000b193e4917ae1
BLAKE2b-256 checksum
How to use checksums
27602ba60c0e3553d297789da3a59af6c68d70f3e7b8835c4c901ed8ec5c62d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / neutrino_api_sdk-1.0.0-py3-none-any.whl

Download URL neutrino_api_sdk-1.0.0-py3-none-any.whl
Size 100.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ec6a84c74e72e17aa3993ab24c7384b3fcb4b04c74b81c26e8e6b6c6946ddb5e
BLAKE2b-256 checksum
How to use checksums
76f33c78f1b89954350cceab1d7b9af8af26b7e6cd557bae1b7746bf7c0dbd2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for neutrino-api-sdk 1.0.0

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

1.0.0 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