openapi-client

Layer1 API making management of crypto assets simple and easy

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import datetime
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.staging.layer1.com
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.staging.layer1.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP message signature: httpSignature
# The HTTP Signature Header mechanism that can be used by a client to
# authenticate the sender of a message and ensure that particular headers
# have not been modified in transit.
#
# You can specify the signing key-id, private key path, signing scheme,
# signing algorithm, list of signed headers and signature max validity.
# The 'key_id' parameter is an opaque string that the API server can use
# to lookup the client and validate the signature.
# The 'private_key_path' parameter should be the path to a file that
# contains a DER or base-64 encoded private key.
# The 'private_key_passphrase' parameter is optional. Set the passphrase
# if the private key is encrypted.
# The 'signed_headers' parameter is used to specify the list of
# HTTP headers included when generating the signature for the message.
# You can specify HTTP headers that you want to protect with a cryptographic
# signature. Note that proxies may add, modify or remove HTTP headers
# for legitimate reasons, so you should only add headers that you know
# will not be modified. For example, if you want to protect the HTTP request
# body, you can specify the Digest header. In that case, the client calculates
# the digest of the HTTP request body and includes the digest in the message
# signature.
# The 'signature_max_validity' parameter is optional. It is configured as a
# duration to express when the signature ceases to be valid. The client calculates
# the expiration date every time it generates the cryptographic signature
# of an HTTP request. The API server may have its own security policy
# that controls the maximum validity of the signature. The client max validity
# must be lower than the server max validity.
# The time on the client and server must be synchronized, otherwise the
# server may reject the client signature.
#
# The client must use a combination of private key, signing scheme,
# signing algorithm and hash algorithm that matches the security policy of
# the API server.
#
# See openapi_client.signing for a list of all supported parameters.
from openapi_client import signing
import datetime

configuration = openapi_client.Configuration(
    host = "https://api.staging.layer1.com",
    signing_info = openapi_client.HttpSigningConfiguration(
        key_id = 'my-key-id',
        private_key_path = 'private_key.pem',
        private_key_passphrase = 'YOUR_PASSPHRASE',
        signing_scheme = openapi_client.signing.SCHEME_HS2019,
        signing_algorithm = openapi_client.signing.ALGORITHM_ECDSA_MODE_FIPS_186_3,
        hash_algorithm = openapi_client.signing.SCHEME_RSA_SHA256,
        signed_headers = [
                            openapi_client.signing.HEADER_REQUEST_TARGET,
                            openapi_client.signing.HEADER_CREATED,
                            openapi_client.signing.HEADER_EXPIRES,
                            openapi_client.signing.HEADER_HOST,
                            openapi_client.signing.HEADER_DATE,
                            openapi_client.signing.HEADER_DIGEST,
                            'Content-Type',
                            'Content-Length',
                            'User-Agent'
                         ],
        signature_max_validity = datetime.timedelta(minutes=5)
    )
)

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.AddressApi(api_client)
    create_address_request = openapi_client.CreateAddressRequest() # CreateAddressRequest | 

    try:
        # Create a new address
        api_response = api_instance.create_address(create_address_request)
        print("The response of AddressApi->create_address:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddressApi->create_address: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.staging.layer1.com

Class	Method	HTTP request	Description
AddressApi	create_address	POST /digital/v1/addresses	Create a new address
AddressApi	get_address	GET /digital/v1/addresses/{addressId}	Get address
AddressApi	list_addresses	GET /digital/v1/addresses	List addresses
AddressApi	list_tags	GET /digital/v1/addresses/{addressId}/tags	List address tags
AddressApi	validate_address	POST /digital/v1/addresses/validate	Validate address
AssetPoolApi	create_asset_pool	POST /digital/v1/asset-pools	Create asset pool
AssetPoolApi	delete_asset_pool	DELETE /digital/v1/asset-pools/{assetPoolId}	Delete asset pool
AssetPoolApi	get_asset_pool	GET /digital/v1/asset-pools/{assetPoolId}	Get asset pool
AssetPoolApi	get_asset_pool_balance	GET /digital/v1/asset-pools/{assetPoolId}/balances	Get asset pool balance
AssetPoolApi	get_asset_pool_max_withdrawable_amount	GET /digital/v1/asset-pools/{assetPoolId}/max-withdrawable-amount	Get max asset pool withdrawable balance
AssetPoolApi	get_asset_pool_summary	GET /digital/v1/asset-pools/summary	Get asset pool summary
AssetPoolApi	list_asset_pools	GET /digital/v1/asset-pools	List asset pools
AssetPoolApi	update_asset_pool	PATCH /digital/v1/asset-pools/{assetPoolId}	Update asset pool
ExportApi	create_balance_export	POST /digital/v1/exports	Create a balance export
ExportApi	get_export	GET /digital/v1/exports/{id}	Get export with a download link
ExportApi	get_exports	GET /digital/v1/exports	List all exports
FeeApi	estimate_transaction_fee	POST /digital/v1/fee-estimate	Estimate transaction fee
KeyPairApi	create_key_pair	POST /digital/v1/key-pairs	Create key pair
KeyPairApi	get_key_pair	GET /digital/v1/key-pairs/{keyPairId}	Get key pair
KeyPairApi	list_key_pairs	GET /digital/v1/key-pairs	List key pairs
NetworkApi	get_networks	GET /digital/v1/networks	Get all networks
ReturnApi	create_return_transaction_request	POST /digital/v1/returns	Create return transaction request
ScreeningApi	list_screenings	GET /digital/v1/screenings	List screening results
ScreeningApi	manually_action_held_transfer	PUT /digital/v1/screenings/action	Approve or reject a held transfer
TransactionApi	claim_transaction	POST /digital/v1/transaction-claims	Claim blockchain transaction
TransactionApi	get_transaction_by_id	GET /digital/v1/transactions/{transactionId}	Get transaction
TransactionApi	list_transactions	GET /digital/v1/transactions	List transactions
TransactionRequestApi	create_staking_transaction	POST /digital/v1/staking-requests	Create staking transaction request
TransactionRequestApi	create_transaction	POST /digital/v1/transaction-requests	Create transaction request
TransactionRequestApi	get_transaction_request_by_id	GET /digital/v1/transaction-requests/{requestId}	Get transaction request
TransactionRequestApi	list_transaction_requests	GET /digital/v1/transaction-requests	List transaction requests

Documentation For Models

• Address
• ApiError
• Asset
• AssetPoolSummary
• AssetValue
• Balance
• BlockDetail
• CreateAddressRequest
• CreateAssetPoolRequest
• CreateBalanceExportRequest
• CreateKeyPairRequest
• CreateStakingTransactionRequest
• CreateTransactionRequest
• Detail
• EstimateTransactionFeeRequest
• Export
• Failure
• KeyPair
• ManualActionRequest
• Network
• NetworkDetail
• Pageable
• PaginatedExports
• PaginatedResultAddress
• PaginatedResultKeyPair
• PaginatedResultTransaction
• PaginatedResultTransactionRequest
• PaginatedScreenings
• Participant
• ReturnRequest
• ScreeningMetadata
• ScreeningView
• Transaction
• TransactionClaimRequest
• TransactionMetadata
• TransactionRequest
• UpdateAssetPoolRequest
• ValidateAddressRequest
• ValidateAddressResponse

Documentation For Authorization

Authentication schemes defined for the API:

openId

httpSignature

• Type: HTTP signature authentication

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Author