java8-digital

Digital Asset

• API version: 1.0.0
  • Generator version: 7.13.0

Layer1 API making management of crypto assets simple and easy

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.layer1.clients</groupId>
  <artifactId>java8-digital</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'java8-digital' jar has been published to maven central.
    mavenLocal()       // Needed if the 'java8-digital' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.layer1.clients:java8-digital:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/java8-digital-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.layer1.clients.java8.digital.invoker.ApiClient;
import com.layer1.clients.java8.digital.invoker.ApiException;
import com.layer1.clients.java8.digital.invoker.Configuration;
import com.layer1.clients.java8.digital.invoker.auth.*;
import com.layer1.clients.java8.digital.model.*;
import com.layer1.clients.java8.digital.api.AddressApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.staging.layer1.com");
    

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    AddressApi apiInstance = new AddressApi(defaultClient);
    CreateAddressRequest createAddressRequest = new CreateAddressRequest(); // CreateAddressRequest | 
    try {
      Address result = apiInstance.createAddress(createAddressRequest)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AddressApi#createAddress");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AddressApi	createAddress	POST /digital/v1/addresses	Create a new address
AddressApi	getAddress	GET /digital/v1/addresses/{addressId}	Get address
AddressApi	listAddresses	GET /digital/v1/addresses	List addresses
AddressApi	listTags	GET /digital/v1/addresses/{addressId}/tags	List address tags
AddressApi	validateAddress	POST /digital/v1/addresses/validate	Validate address
AssetPoolApi	createAssetPool	POST /digital/v1/asset-pools	Create asset pool
AssetPoolApi	deleteAssetPool	DELETE /digital/v1/asset-pools/{assetPoolId}	Delete asset pool
AssetPoolApi	getAssetPool	GET /digital/v1/asset-pools/{assetPoolId}	Get asset pool
AssetPoolApi	getAssetPoolBalance	GET /digital/v1/asset-pools/{assetPoolId}/balances	Get asset pool balance
AssetPoolApi	getAssetPoolMaxWithdrawableAmount	GET /digital/v1/asset-pools/{assetPoolId}/max-withdrawable-amount	Get max asset pool withdrawable balance
AssetPoolApi	getAssetPoolSummary	GET /digital/v1/asset-pools/summary	Get asset pool summary
AssetPoolApi	listAssetPools	GET /digital/v1/asset-pools	List asset pools
AssetPoolApi	updateAssetPool	PATCH /digital/v1/asset-pools/{assetPoolId}	Update asset pool
ExportApi	createBalanceExport	POST /digital/v1/exports	Create a balance export
ExportApi	getExport	GET /digital/v1/exports/{id}	Get export with a download link
ExportApi	getExports	GET /digital/v1/exports	List all exports
FeeApi	estimateTransactionFee	POST /digital/v1/fee-estimate	Estimate transaction fee
KeyPairApi	createKeyPair	POST /digital/v1/key-pairs	Create key pair
KeyPairApi	getKeyPair	GET /digital/v1/key-pairs/{keyPairId}	Get key pair
KeyPairApi	listKeyPairs	GET /digital/v1/key-pairs	List key pairs
NetworkApi	getNetworks	GET /digital/v1/networks	Get all networks
ReturnApi	createReturnTransactionRequest	POST /digital/v1/returns	Create return transaction request
ScreeningApi	listScreenings	GET /digital/v1/screenings	List screening results
ScreeningApi	manuallyActionHeldTransfer	PUT /digital/v1/screenings/action	Approve or reject a held transfer. Deposits can be only approved.
TransactionApi	claimTransaction	POST /digital/v1/transaction-claims	Claim blockchain transaction
TransactionApi	getTransactionById	GET /digital/v1/transactions/{transactionId}	Get transaction
TransactionApi	listTransactions	GET /digital/v1/transactions	List transactions
TransactionRequestApi	createStakingTransaction	POST /digital/v1/staking-requests	Create staking transaction request
TransactionRequestApi	createTransaction	POST /digital/v1/transaction-requests	Create transaction request
TransactionRequestApi	getTransactionRequestById	GET /digital/v1/transaction-requests/{requestId}	Get transaction request
TransactionRequestApi	listTransactionRequests	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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author