Skip to content

BL0CK-X/theblockchainapi-kotlin-wrapper

BranchesTags

Repository files navigation

org.openapitools.client - Kotlin client library for The Blockchain API

Requires

  • Kotlin 1.4.30
  • Gradle 6.8.3

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
  • Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

All URIs are relative to https://api.blockchainapi.com/v1

Class Method HTTP request Description
CCPaymentApi getCCPayment GET /checkout/v1/project/{project_id}/payment/{payment_identifier} Get a payment
CCPaymentApi listAllCCPayments GET /checkout/v1/payments List all payments
CCPaymentApi listCCProjectPayments GET /checkout/v1/project/{project_id}/payments List a project's payments
CCProjectApi createCCProject POST /checkout/v1/project Create a project
CCProjectApi deleteCCProject DELETE /checkout/v1/project/{project_id} Delete a project
CCProjectApi getCCProject GET /checkout/v1/project/{project_id} Get a project
CCProjectApi listCCProjects GET /checkout/v1/projects List projects
CCProjectApi updateCCProject PUT /checkout/v1/project/{project_id} Update a project
CCWebhookApi getCCWebhook POST /webhook/v1/project/{project_id}/webhook/{webhook_identifier} Get a webhook
CCWebhookApi listCCProjectWebhooks POST /webhook/v1/project/{project_id}/webhooks List project's webhooks
CCWebhookApi validateCCWebhook POST /webhook/v1/project/{project_id}/webhook/{webhook_identifier}/validate Validate a webhook
NameServiceApi getBlockchainIdentifierFromName POST /{blockchain}/{network}/name_service/name_to_blockchain_identifier Get the identifier
NameServiceApi getNameForBlockchainIdentifier POST /{blockchain}/{network}/name_service/blockchain_identifier_to_name Get the name
SolanaAccountApi solanaGetAccount GET /solana/account/{network}/{public_key} Get the details of an account on Solana
SolanaAccountApi solanaGetAccountIsCandyMachine GET /solana/account/{network}/{public_key}/is_candy_machine Get if account is candy machine
SolanaAccountApi solanaGetAccountIsNFT GET /solana/account/{network}/{public_key}/is_nft Get if account is NFT
SolanaCandyMachineApi solanaGetAllNFTsFromCandyMachine GET /solana/nft/candy_machine/{network}/{candy_machine_id}/nfts Get CM's NFTs
SolanaCandyMachineApi solanaGetCandyMachineMetadata POST /solana/nft/candy_machine/metadata Get a CM's metadata
SolanaCandyMachineApi solanaListAllCandyMachines GET /solana/nft/candy_machine/list List all CMs
SolanaCandyMachineApi solanaSearchCandyMachines POST /solana/nft/candy_machine/search Search CMs
SolanaNFTApi solanaCreateNFT POST /solana/nft Create an NFT on Solana
SolanaNFTApi solanaGetNFT GET /solana/nft/{network}/{mint_address} Get an NFT's metadata
SolanaNFTApi solanaGetNFTMintFee GET /solana/nft/mint/fee Get the NFT mint fee
SolanaNFTApi solanaGetNFTOwner GET /solana/nft/{network}/{mint_address}/owner Get owner of an NFT
SolanaNFTApi solanaGetNFTOwnerAdvanced GET /solana/nft/{network}/{mint_address}/owner_advanced Get owner of an NFT (advanced)
SolanaNFTApi solanaGetNFTsCandyMachineId POST /solana/nft/candy_machine_id Get the ID of the candy machine of an NFT
SolanaNFTApi solanaSearchNFTs POST /solana/nft/search Search NFTs on Solana
SolanaSPLTokenApi solanaGetSPLToken GET /solana/spl-token/{network}/{public_key} Get SPL token metadata
SolanaTransactionApi solanaGetTransaction GET /solana/transaction/{network}/{tx_signature} Get the details of a transaction made on Solana
SolanaWalletApi solanaDeriveAssociatedTokenAccountAddress GET /solana/wallet/{public_key}/associated_token_account/{mint_address} Derive an associated token account address
SolanaWalletApi solanaDerivePrivateKey POST /solana/wallet/private_key Derive private key
SolanaWalletApi solanaDerivePublicKey POST /solana/wallet/public_key Derive public key
SolanaWalletApi solanaGeneratePrivateKey POST /solana/wallet/generate/private_key Generate private key
SolanaWalletApi solanaGenerateSecretRecoveryPhrase POST /solana/wallet/generate/secret_recovery_phrase Generate secret phrase
SolanaWalletApi solanaGetAirdrop POST /solana/wallet/airdrop Get an airdrop on devnet
SolanaWalletApi solanaGetBalance POST /solana/wallet/balance Get wallet's balance in SOL or any SPL
SolanaWalletApi solanaGetNFTsBelongingToWallet GET /solana/wallet/{network}/{public_key}/nfts Get address's NFTs
SolanaWalletApi solanaGetTokensBelongingToWallet GET /solana/wallet/{network}/{public_key}/tokens Get address's tokens and respective balances
SolanaWalletApi solanaGetWalletTransactions GET /solana/wallet/{network}/{public_key}/transactions Get address's associated transaction signatures
SolanaWalletApi solanaTransfer POST /solana/wallet/transfer Transfer SOL, a token, or an NFT to another address
TokenApi getTokenMetadata GET /{blockchain}/{network}/token/{token_blockchain_identifier} Get a token's metadata
TokenApi listAllTokens GET /{blockchain}/{network}/all_tokens List all tokens
TransactionApi getTransaction GET /{blockchain}/transaction/{network}/{transaction_blockchain_identifier} Get the details of a transaction made on a blockchain
WalletApi derivePrivateKey POST /{blockchain}/wallet/private_key Derive private key
WalletApi deriveWalletIdentifier POST /{blockchain}/wallet/identifier Derive wallet identifier
WalletApi generatePrivateKey POST /{blockchain}/wallet/generate/private_key Generate private key
WalletApi generateSeedPhrase POST /{blockchain}/wallet/generate/secret_recovery_phrase Generate seed phrase
WalletApi getAirdrop POST /{blockchain}/wallet/airdrop Get an airdrop
WalletApi getBalance POST /{blockchain}/wallet/balance Get wallet's balance of X
WalletApi transfer POST /{blockchain}/wallet/transfer Transfer crypto, a token, or an NFT to another wallet

Documentation for Models

Documentation for Authorization

APIKeyID

  • Type: API key
  • API key parameter name: APIKeyID
  • Location: HTTP header

APISecretKey

  • Type: API key
  • API key parameter name: APISecretKey
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages