Algorand is a decentralized blockchain technology network. Algorand
- is enabling the simple creation of next generation financial products, protocols
- and exchange of value across defi, financial institutions and governments.
+ - description:
+ '
Algorand is a decentralized blockchain technology network. Algorand
+ is enabling the simple creation of next generation financial products, protocols
+ and exchange of value across defi, financial institutions and governments.
- Tatum supports 2 chains:
+ Tatum supports 2 chains:
-
Bitcoin Blockchain enables access to the most commonly used Bitcoin
+ methods. These methods bring a small level of abstraction
+
+ and are used for applications that communicate with the blockchain directly. Some
+ of the methods are used alongside Tatum Private Ledger
+
+ to connect the blockchain and the private ledger, like wallet generation or getting
+ information about transactions.
+
+ Tatum supports 2 chains:
+
+
Bitcoin Cash Blockchain enables access to the most commonly used\
+ \ Bitcoin Cash methods. These methods bring a small level of abstraction\n and\
+ \ are used for applications that communicate with the blockchain directly. Some\
+ \ of the methods are used alongside Tatum Private Ledger\n to connect the blockchain\
+ \ and the private ledger, like wallet generation or getting information about\
+ \ transactions.
\nTatum supports 2 chains:\n
Binance Smart Chain is an Ethereum EVM 100% compatible blockchain,
+ and is very good for decentralized application (Dapp) development within many
+ possible verticals including DeFi, NFT, Gaming, and many others.
+
+ Tatum supports 2 chains:
+
+
BNB + Beacon Chain is a blockchain developed by Binance. With Tatum, you can access the most commonly used + BNB Beacon Chain methods. These methods bring a certain level of abstraction and + are used for applications that communicate with the blockchain directly.
+ +BNB Beacon Chain does not provide the smart contract functionality.
+ +Tatum supports the following BNB Beacon Chain networks:
+ +Cardano is a + decentralized, open-source blockchain. With Tatum, you can access the most commonly + used Cardano methods. These methods bring a certain level of abstraction and are + used for applications that communicate with the blockchain directly. Some of the + methods are used alongside virtual accounts to connect the blockchain and a virtual + account, like generating a wallet or getting information about transactions.
+ +Tatum supports Cardano mainnet and Cardano preproduction testnet.
+ + ' + name: Cardano + - description: + "Celo is fork of Celo with more than 1000 tps and possibility to\
+ \ pay for\ntransactions in it's own stable coin, cUSD. Celo Blockchain enables\
+ \ access to most commonly used Celo methods.\nThese methods bring small level\
+ \ of abstraction,\n and are used for the type of applications that want\
+ \ to communicate with blockchain directly. Some of the methods are used alongside\
+ \ Tatum Private Ledger\n to connect blockchain and private ledger together,\
+ \ like wallet generation or getting information about transactions.
\n \
+ \ Tatum supports 2 chains:\n
Dogecoin Blockchain enables access to the most commonly used Dogecoin\
+ \ methods. These methods bring a small level of abstraction\n and are used for\
+ \ applications that communicate with the blockchain directly. Some of the methods\
+ \ are used alongside Tatum Private Ledger\n to connect the blockchain and the\
+ \ private ledger, like wallet generation or getting information about transactions.
\n\
+ Tatum supports 2 chains:\n
Elrond (EGLD) is a distributed transactional computation protocol
+ which relies on a sharded state architecture and a secure Proof of Stake consensus
+ mechanism.
+
+
+
+ Tatum supports 2 chains:
+
+
Ethereum is + a decentralized, open-source blockchain. With Tatum, you can access the most commonly + used Ethereum methods. These methods bring a certain level of abstraction and + are used for applications that communicate with the blockchain directly. Some + of the methods are used alongside virtual accounts to connect the blockchain and + a virtual account, like generating a wallet or getting information about transactions.
+ +Tatum supports the following Ethereum networks:
+ +Flow Blockchain enables access to the most commonly used Flow methods.\
+ \ These methods bring a small level of abstraction\n and are used for applications\
+ \ that communicate with the blockchain directly. Some of the methods are used\
+ \ alongside Tatum Private Ledger\n to connect the blockchain and the private ledger,\
+ \ like wallet generation or getting information about transactions.
\nTatum\
+ \ supports FLOW and FUSD stable coin.
\nTatum supports 2 chains:\n
Harmony.ONE is an Oneeum L2 scaling solution 100% EVM compatible,
+ and is very good for decentralized application (Dapp) development within many
+ possible verticals including DeFi, NFT, Gaming, and many others.
+
+ Tatum supports 2 chains:
+
+
Klaytn is an Ethereum EVM 100% compatible blockchain, and is very
+ good for decentralized application (Dapp) development within many possible verticals
+ including DeFi, NFT, Gaming, and many others.
+
+ Tatum supports 2 chains:
+
+
Kcs (KCS) is an Ethereum EVM 100% compatible blockchain, and is
+ very good for decentralized application (Dapp) development within many possible
+ verticals including DeFi, NFT, Gaming, and many others.
+
+ Tatum supports 2 chains:
+
+
Litecoin Blockchain enables access to the most commonly used Litecoin\
+ \ methods. These methods bring a small level of abstraction and are used for applications\
+ \ that communicate with the blockchain directly. Some of the methods are used\
+ \ alongside Tatum Private Ledger\n to connect the blockchain and the private ledger,\
+ \ like wallet generation or getting information about transactions.
\nExamples\
+ \ of working with the Litecoin blockchain can be found in Tatum LTC SDK.
\nTatum supports 2 chains:\n
Polygon (Matic) is an Ethereum EVM 100% compatible blockchain,
+ and is very good for decentralized application (Dapp) development within many
+ possible verticals including DeFi, NFT, Gaming, and many others.
+
+ Tatum supports 2 chains:
+
+
Solana is a blockchain network focused on fast transactions and
+ high throughput. It uses a unique method of ordering transactions to improve its
+ speed. Users can pay their transaction fees and interact with smart contracts
+ with SOL, the network''s native cryptocurrency.
- a faucet, e.g. https://bank.testnet.algorand.network/
-
- Examples of working with the Algorand blockchain can be found in Tatum ALGO SDK.
-
-
Bitcoin Blockchain enables access to the most commonly used Bitcoin
- methods. These methods bring a small level of abstraction
-
- and are used for applications that communicate with the blockchain directly. Some
- of the methods are used alongside Tatum Private Ledger
-
- to connect the blockchain and the private ledger, like wallet generation or getting
- information about transactions.
-
- Tatum supports 2 chains:
-
-
Bitcoin Cash Blockchain enables access to the most commonly used\
- \ Bitcoin Cash methods. These methods bring a small level of abstraction\n and\
- \ are used for applications that communicate with the blockchain directly. Some\
- \ of the methods are used alongside Tatum Private Ledger\n to connect the blockchain\
- \ and the private ledger, like wallet generation or getting information about\
- \ transactions.
\nTatum supports 2 chains:\n
Binance Smart Chain is an Ethereum EVM 100% compatible blockchain,
- and is very good for decentralized application (Dapp) development within many
- possible verticals including DeFi, NFT, Gaming, and many others.
-
- Tatum supports 2 chains:
-
-
BNB - Beacon Chain is a blockchain developed by Binance. With Tatum, you can access the most commonly used - BNB Beacon Chain methods. These methods bring a certain level of abstraction and - are used for applications that communicate with the blockchain directly.
- -BNB Beacon Chain does not provide the smart contract functionality.
- -Tatum supports the following BNB Beacon Chain networks:
- -Cardano is a - decentralized, open-source blockchain. With Tatum, you can access the most commonly - used Cardano methods. These methods bring a certain level of abstraction and are - used for applications that communicate with the blockchain directly. Some of the - methods are used alongside virtual accounts to connect the blockchain and a virtual - account, like generating a wallet or getting information about transactions.
- -Tatum supports Cardano mainnet and Cardano preproduction testnet.
- - ' - name: Cardano -- description: "Celo is fork of Celo with more than 1000 tps and possibility to\
- \ pay for\ntransactions in it's own stable coin, cUSD. Celo Blockchain enables\
- \ access to most commonly used Celo methods.\nThese methods bring small level\
- \ of abstraction,\n and are used for the type of applications that want\
- \ to communicate with blockchain directly. Some of the methods are used alongside\
- \ Tatum Private Ledger\n to connect blockchain and private ledger together,\
- \ like wallet generation or getting information about transactions.
\n \
- \ Tatum supports 2 chains:\n
Dogecoin Blockchain enables access to the most commonly used Dogecoin\
- \ methods. These methods bring a small level of abstraction\n and are used for\
- \ applications that communicate with the blockchain directly. Some of the methods\
- \ are used alongside Tatum Private Ledger\n to connect the blockchain and the\
- \ private ledger, like wallet generation or getting information about transactions.
\n\
- Tatum supports 2 chains:\n
Elrond (EGLD) is a distributed transactional computation protocol
- which relies on a sharded state architecture and a secure Proof of Stake consensus
- mechanism.
-
-
-
- Tatum supports 2 chains:
-
-
Ethereum is - a decentralized, open-source blockchain. With Tatum, you can access the most commonly - used Ethereum methods. These methods bring a certain level of abstraction and - are used for applications that communicate with the blockchain directly. Some - of the methods are used alongside virtual accounts to connect the blockchain and - a virtual account, like generating a wallet or getting information about transactions.
- -Tatum supports the following Ethereum networks:
- -Flow Blockchain enables access to the most commonly used Flow methods.\
- \ These methods bring a small level of abstraction\n and are used for applications\
- \ that communicate with the blockchain directly. Some of the methods are used\
- \ alongside Tatum Private Ledger\n to connect the blockchain and the private ledger,\
- \ like wallet generation or getting information about transactions.
\nTatum\
- \ supports FLOW and FUSD stable coin.
\nTatum supports 2 chains:\n
Harmony.ONE is an Oneeum L2 scaling solution 100% EVM compatible,
- and is very good for decentralized application (Dapp) development within many
- possible verticals including DeFi, NFT, Gaming, and many others.
-
- Tatum supports 2 chains:
-
-
Klaytn is an Ethereum EVM 100% compatible blockchain, and is very
- good for decentralized application (Dapp) development within many possible verticals
- including DeFi, NFT, Gaming, and many others.
-
- Tatum supports 2 chains:
-
-
Kcs (KCS) is an Ethereum EVM 100% compatible blockchain, and is
- very good for decentralized application (Dapp) development within many possible
- verticals including DeFi, NFT, Gaming, and many others.
+ For now, Solana is in BETA and there is a rate limitation applied for
+ all projects for Solana to 40 req/s on the platform.
- Tatum supports 2 chains:
+ Tatum supports 2 chains:
-
Litecoin Blockchain enables access to the most commonly used Litecoin\
- \ methods. These methods bring a small level of abstraction and are used for applications\
- \ that communicate with the blockchain directly. Some of the methods are used\
- \ alongside Tatum Private Ledger\n to connect the blockchain and the private ledger,\
- \ like wallet generation or getting information about transactions.
\nExamples\
- \ of working with the Litecoin blockchain can be found in Tatum LTC SDK.
\nTatum supports 2 chains:\n
Polygon (Matic) is an Ethereum EVM 100% compatible blockchain,
- and is very good for decentralized application (Dapp) development within many
- possible verticals including DeFi, NFT, Gaming, and many others.
+ '
+ name: Solana
+ - description:
+ '
XLM Blockchain enables access to the most commonly used XLM methods. + These methods bring a small level of abstraction - Tatum supports 2 chains: + and are used for applications that communicate with the blockchain directly. Some + of the methods are used alongside Tatum Private Ledger -
Solana is a blockchain network focused on fast transactions and
- high throughput. It uses a unique method of ordering transactions to improve its
- speed. Users can pay their transaction fees and interact with smart contracts
- with SOL, the network''s native cryptocurrency.
+
Tron Blockchain enables access to most commonly used Tron methods.
+ It''s possible to generate TRON account, send TRX, TRC10 and TRC20 assets. It''s
+ also possible to generate custom TRC10 or TRC20 tokens using API.
- a faucet, e.g. https://solfaucet.com/
XLM Blockchain enables access to the most commonly used XLM methods. - These methods bring a small level of abstraction +
VeChain Blockchain enables access to the most commonly used VeChain + methods. Tatum does not support off-chain capabilities for the VET blockchain. - Tatum supports 2 chains: + Tatum KMS is not supported for VET transactions. VET supports 2 native assets + - VET and VTHO. VTHO is used for paying transaction fees. -
Tron Blockchain enables access to most commonly used Tron methods.
- It''s possible to generate TRON account, send TRX, TRC10 and TRC20 assets. It''s
- also possible to generate custom TRC10 or TRC20 tokens using API.
+ a faucet, e.g. https://faucet.vecha.in/
XDC Network (XinFin) is enterprise ready hybrid blockchain for + global trade and finance, combining the power of Public & Private blockchains + with interoperable Smart Contracts. -
VeChain Blockchain enables access to the most commonly used VeChain - methods. Tatum does not support off-chain capabilities for the VET blockchain. +
XRPL is a decentralized + public blockchain. With Tatum, you can access the most commonly used XRPL methods. + These methods bring a certain level of abstraction and are used for applications + that communicate with the blockchain directly. Some of the methods are used alongside + virtual accounts to connect the blockchain and a virtual account, like generating + a wallet or getting information about transactions.
-Tatum supports the following XRPL networks:
-XDC Network (XinFin) is enterprise ready hybrid blockchain for
- global trade and finance, combining the power of Public & Private blockchains
- with interoperable Smart Contracts.
+
-
+
To start using the XRPL blockchain, create an XRPL account. On XRPL, the same + account is used for the mainnet and the testnet. To activate the account, credit + it with 20 XRP.
- Tatum supports 2 chains: +Because of the activation requirement, it is common to use one account for
+ all customers and differentiate them via Destination tags. A Destination
+ tag is a number included in every transaction as an account distinguisher.
When an off-chain deposit address is created for a virtual account, a Destination
+ tag is generated for that account (for example, 12345). When you
+ make a transaction to the blockchain, be sure to include the address of the recipient
+ and the Destination tag as an account distinguisher. Examples of
+ working with the XRP blockchain can be found in Tatum XRP SDK.
XRPL is a decentralized - public blockchain. With Tatum, you can access the most commonly used XRPL methods. - These methods bring a certain level of abstraction and are used for applications - that communicate with the blockchain directly. Some of the methods are used alongside - virtual accounts to connect the blockchain and a virtual account, like generating - a wallet or getting information about transactions.
- -Tatum supports the following XRPL networks:
- -To start using the XRPL blockchain, create an XRPL account. On XRPL, the same - account is used for the mainnet and the testnet. To activate the account, credit - it with 20 XRP.
- -Because of the activation requirement, it is common to use one account for
- all customers and differentiate them via Destination tags. A Destination
- tag is a number included in every transaction as an account distinguisher.
When an off-chain deposit address is created for a virtual account, a Destination
- tag is generated for that account (for example, 12345). When you
- make a transaction to the blockchain, be sure to include the address of the recipient
- and the Destination tag as an account distinguisher. Examples of
- working with the XRP blockchain can be found in Tatum XRP SDK.
Interact with the blockchain directly by connecting to the blockchain - node and communicating with it through JSON-RPC.
+ - description: + "Interact with the blockchain directly by connecting to the blockchain + node and communicating with it through JSON-RPC.
-Each node-related API supports its own set of the blockchains. The list of - the supported blockchains is provided in the API description further in this section.
+Each node-related API supports its own set of the blockchains. The list of + the supported blockchains is provided in the API description further in this section.
- ' - name: Node RPC + " + name: Node RPC servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v3/blockchain/node/{chain}/{xApiKey}/{rpcPath}: post: @@ -21,3 +22,7 @@ paths: $ref: categories/blockchain_node_rpc/paths/v3_blockchain_node_{chain}_{xApiKey}_{rpcPath}_put.yml get: $ref: categories/blockchain_node_rpc/paths/v3_blockchain_node_{chain}_{xApiKey}_{rpcPath}_get.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/fee_estimation/openapi.yml b/categories/fee_estimation/openapi.yml index e429e95..3b71917 100644 --- a/categories/fee_estimation/openapi.yml +++ b/categories/fee_estimation/openapi.yml @@ -4,7 +4,7 @@ info: version: 3.18.3 tags: [] servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v3/blockchain/fee/{chain}: get: @@ -48,3 +48,7 @@ paths: /v3/offchain/blockchain/estimate: post: $ref: categories/fee_estimation/paths/v3_offchain_blockchain_estimate_post.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/security/openapi.yml b/categories/security/openapi.yml index 3eaaad2..9c0e801 100644 --- a/categories/security/openapi.yml +++ b/categories/security/openapi.yml @@ -3,84 +3,87 @@ info: title: Security version: 3.18.3 tags: -- description: 'Key - Management System (KMS) is a comprehensive solution for building custodial - applications. KMS runs locally on your server and provides security for generating - wallets, addresses, and private keys, and for signing transactions.
+ - description: + 'Key + Management System (KMS) is a comprehensive solution for building custodial + applications. KMS runs locally on your server and provides security for generating + wallets, addresses, and private keys, and for signing transactions.
-KMS builds a list of pending transaction to sign and provides the options to - complete a transaction after it has been signed and to obtain transaction details - with the result of the blockchain operation via the transaction ID.
+KMS builds a list of pending transaction to sign and provides the options to + complete a transaction after it has been signed and to obtain transaction details + with the result of the blockchain operation via the transaction ID.
-In KMS, each managed wallet or private key is assigned a unique signature ID
- (signatureId) that represents that wallet or private key. This signature
- ID is then used in an API request to identify the wallet.
In KMS, each managed wallet or private key is assigned a unique signature ID
+ (signatureId) that represents that wallet or private key. This signature
+ ID is then used in an API request to identify the wallet.
Depending on the API, you can use the signature ID in an API call request in - the following ways:
+Depending on the API, you can use the signature ID in an API call request in + the following ways:
-transferBtcKMS request schema).transferBtcKMS request schema).
- BtcTransactionFromUTXOKMS
- request schema).BtcTransactionFromUTXOKMS
+ request schema).transferEthKMS request schema).transferEthKMS request schema).You can run KMS on the following operating systems:
+You can run KMS on the following operating systems:
-For more information about KMS, see the KMS GitHub repository and the user documentation.
+For more information about KMS, see the KMS GitHub repository and the user documentation.
- + - ' - name: Key Management System -- description: 'An endpoint to check if the blockchain address is safe to work - with or not.
+ ' + name: Key Management System + - description: + "An endpoint to check if the blockchain address is safe to work + with or not.
- ' - name: Malicious address -- description: 'Custodial API is a set of operations, which allows you to work - with managed blockchain addresses without having its private key. + " + name: Malicious address + - description: + "
Custodial API is a set of operations, which allows you to work
+ with managed blockchain addresses without having its private key.
- You can easily create new managed address and export its details - with private
- key as well - once required.
+ You can easily create new managed address and export its details - with private
+ key as well - once required.
- This features are currently in Alpha version.
"NFT" stands for "Non-Fungible Token", which means that each token - is unique and irreplaceable. NFTs are described by the ERC-721 standard on the - Ethereum blockchain or by the equivalent standard on the other blockchains.
+ - description: + '"NFT" stands for "Non-Fungible Token", which means that each token + is unique and irreplaceable. NFTs are described by the ERC-721 standard on the + Ethereum blockchain or by the equivalent standard on the other blockchains.
-NFTs can be used for nearly any digital asset or good to ensure authenticity - and scarcity, for example:
+
NFTs can be used for nearly any digital asset or good to ensure authenticity + and scarcity, for example:
-
Each NFT-related API its own set of the blockchains. The list of the supported - blockchains is provided in the API description further in this section.
+Each NFT-related API its own set of the blockchains. The list of the supported + blockchains is provided in the API description further in this section.
- ' - name: NFT (ERC-721 or compatible) -- description: 'Fungible tokens are interchangeable and are used as a blockchain - representation of the currency. Fungible tokens are described by the ERC-20 standard - on the Ethereum blockchain or by the equivalent standard on the other blockchains.
+ ' + name: NFT (ERC-721 or compatible) + - description: + "Fungible tokens are interchangeable and are used as a blockchain + representation of the currency. Fungible tokens are described by the ERC-20 standard + on the Ethereum blockchain or by the equivalent standard on the other blockchains.
-Each API related to fungible tokens supports its own set of the blockchains. - The list of the supported blockchains is provided in the operation description - further in this section.
+Each API related to fungible tokens supports its own set of the blockchains. + The list of the supported blockchains is provided in the operation description + further in this section.
- ' - name: Fungible Tokens (ERC-20 or compatible) -- description: 'A Multi Token combines characteristics of fungible and non-fungible - tokens. A single Multi Token smart contract allows you to mint fungible, non-fungible, - and semi-fungible tokens and process different types of the tokens in a single - transaction. Multi Tokens are described by the ERC-1155 standard on the Ethereum - blockchain or by the equivalent standard on the other blockchains.
+ " + name: Fungible Tokens (ERC-20 or compatible) + - description: + "A Multi Token combines characteristics of fungible and non-fungible + tokens. A single Multi Token smart contract allows you to mint fungible, non-fungible, + and semi-fungible tokens and process different types of the tokens in a single + transaction. Multi Tokens are described by the ERC-1155 standard on the Ethereum + blockchain or by the equivalent standard on the other blockchains.
-Multi Tokens can be used for nearly any digital asset or good to ensure authenticity - and scarcity, for example:
+
Multi Tokens can be used for nearly any digital asset or good to ensure authenticity + and scarcity, for example:
-
Each Multi Token-related API supports its own set of the blockchains. The list - of the supported blockchains is provided in the API description further in this - section.
+Each Multi Token-related API supports its own set of the blockchains. The list + of the supported blockchains is provided in the API description further in this + section.
- ' - name: Multi Tokens (ERC-1155 or compatible) -- description: 'The gas pump is Tatum''s feature that helps you manage gas fees - in a custodial application. When you use the gas pump, gas fees for any transaction - made by your customers (users of your custodial application) are automatically - deducted from the master address instead of the customer''s address. This eliminates - the need to send crypto to each customer''s address to pay for gas fees.
+ " + name: Multi Tokens (ERC-1155 or compatible) + - description: + 'The gas pump is Tatum''s feature that helps you manage gas fees + in a custodial application. When you use the gas pump, gas fees for any transaction + made by your customers (users of your custodial application) are automatically + deducted from the master address instead of the customer''s address. This eliminates + the need to send crypto to each customer''s address to pay for gas fees.
-For more information about the gas pump, see our user documentation.
+For more information about the gas pump, see our user documentation.
-Each API related to the gas pump supports its own set of the blockchains. The - list of the supported blockchains is provided in the API description further in - this section.
+Each API related to the gas pump supports its own set of the blockchains. The + list of the supported blockchains is provided in the API description further in + this section.
- ' - name: Gas pump -- description: 'Build a peer-to-peer NFT marketplace and allow your customers to - sell and buy assets. When an asset is sold, the creator is automatically paid, - the asset is instantly transferred to the buyer, and you as the owner of the marketplace - automatically receive a percentage of the transaction.
+ ' + name: Gas pump + - description: + "Build a peer-to-peer NFT marketplace and allow your customers to + sell and buy assets. When an asset is sold, the creator is automatically paid, + the asset is instantly transferred to the buyer, and you as the owner of the marketplace + automatically receive a percentage of the transaction.
-Each marketplace-related API supports its own set of the blockchains. The list - of the supported blockchains is provided in the API description further in this - section.
+Each marketplace-related API supports its own set of the blockchains. The list + of the supported blockchains is provided in the API description further in this + section.
- ' - name: Marketplace + " + name: Marketplace servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v1/contract/deploy: post: @@ -325,3 +330,7 @@ paths: /v3/nft/address/{chain}/{hash}: get: $ref: categories/smart_contracts/paths/v3_nft_address_{chain}_{hash}_get.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/storage/openapi.yml b/categories/storage/openapi.yml index b0d2a5e..846fb6b 100644 --- a/categories/storage/openapi.yml +++ b/categories/storage/openapi.yml @@ -3,20 +3,22 @@ info: title: Storage version: 3.18.3 tags: -- description: 'IPFS is a distributed file storage. You can store data to IPFS - and read from them.
+ - description: + "IPFS is a distributed file storage. You can store data to IPFS + and read from them.
- ' - name: IPFS -- description: 'You can store data records on the blockchain. A record is stored - permanently: it cannot be changed, + " + name: IPFS + - description: + "
You can store data records on the blockchain. A record is stored + permanently: it cannot be changed, - deleted, or modified by anyone and will be stored on the blockchain forever. + deleted, or modified by anyone and will be stored on the blockchain forever. - ' - name: Blockchain storage + " + name: Blockchain storage servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v3/record: post: @@ -29,3 +31,7 @@ paths: /v3/ipfs: post: $ref: categories/storage/paths/v3_ipfs_post.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/subscriptions/openapi.yml b/categories/subscriptions/openapi.yml index 001eea2..3ccd91f 100644 --- a/categories/subscriptions/openapi.yml +++ b/categories/subscriptions/openapi.yml @@ -3,17 +3,18 @@ info: title: Subscriptions version: 3.18.3 tags: -- description: '
Endpoints to handle subscriptions to the Tatum Platform. Subscriptions - allow users to enable some additional features or reports that are not enabled - by default, + - description: + "
Endpoints to handle subscriptions to the Tatum Platform. Subscriptions + allow users to enable some additional features or reports that are not enabled + by default, - like outgoing off-chain transaction scanning, accounts with balances above the - limit, etc.
+ like outgoing off-chain transaction scanning, accounts with balances above the + limit, etc. - ' - name: Notification subscriptions + " + name: Notification subscriptions servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v1/subscription: post: @@ -42,3 +43,7 @@ paths: /v3/subscription/webhook/count: get: $ref: categories/subscriptions/paths/v3_subscription_webhook_count_get.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/utils/openapi.yml b/categories/utils/openapi.yml index 216a544..6d930e9 100644 --- a/categories/utils/openapi.yml +++ b/categories/utils/openapi.yml @@ -3,16 +3,17 @@ info: title: Utils version: 3.18.3 tags: -- description: 'The utility APIs help you use some native blockchain features such - as getting the address of a smart contract or estimating the block number.
+ - description: + "The utility APIs help you use some native blockchain features such + as getting the address of a smart contract or estimating the block number.
-Each utility API supports its own set of the blockchains. The list of the supported - blockchains is provided in the API description further in this section.
+Each utility API supports its own set of the blockchains. The list of the supported + blockchains is provided in the API description further in this section.
- ' - name: Blockchain utils + " + name: Blockchain utils servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v3/blockchain/sc/address/{chain}/{hash}: get: @@ -37,3 +38,7 @@ paths: $ref: categories/utils/paths/v3_tatum_freeze_put.yml delete: $ref: categories/utils/paths/v3_tatum_freeze_delete.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key diff --git a/categories/virtual_accounts/openapi.yml b/categories/virtual_accounts/openapi.yml index a1fdc34..dc633cd 100644 --- a/categories/virtual_accounts/openapi.yml +++ b/categories/virtual_accounts/openapi.yml @@ -3,107 +3,114 @@ info: title: Virtual Accounts version: 3.18.3 tags: -- description: 'A Tatum Account is the primary building block of Tatum-powered
- applications. It is an envelope that holds essential information about balances,
- the state of the account or customer, and to whom the account belongs.
+ - description:
+ "
A Tatum Account is the primary building block of Tatum-powered
+ applications. It is an envelope that holds essential information about balances,
+ the state of the account or customer, and to whom the account belongs.
- Accounts in Tatum are stored within Tatum Private Ledger. Tatum Private Ledger
- contains information about accounts, the customers that own the accounts, transactions
- that affect the accounts or virtual currencies present in the ledger.
+ Accounts in Tatum are stored within Tatum Private Ledger. Tatum Private Ledger
+ contains information about accounts, the customers that own the accounts, transactions
+ that affect the accounts or virtual currencies present in the ledger.
- By default, the private ledger is not connected to any blockchain. It is possible
- to create an application on it without any blockchain at all. Using Tatum Private
- Ledger and the building blocks included within it, it is possible to quickly swap
- the whole application from the ledger to any blockchain supported by Tatum. All
- of the API calls will remain the same, the only thing that changes is the blockchain
- the application lives on.
+ By default, the private ledger is not connected to any blockchain. It is possible
+ to create an application on it without any blockchain at all. Using Tatum Private
+ Ledger and the building blocks included within it, it is possible to quickly swap
+ the whole application from the ledger to any blockchain supported by Tatum. All
+ of the API calls will remain the same, the only thing that changes is the blockchain
+ the application lives on.
- Most blockchains do not have any compliance layer at all. It is not possible to
- freeze funds at a blockchain address or deactivate an address. The Tatum Account
- has built-in compliance, and it is possible to block funds in the account, freeze
- outgoing transactions from the account or even completely deactivate the account.
+ Most blockchains do not have any compliance layer at all. It is not possible to
+ freeze funds at a blockchain address or deactivate an address. The Tatum Account
+ has built-in compliance, and it is possible to block funds in the account, freeze
+ outgoing transactions from the account or even completely deactivate the account.
-
An endpoint used to create and list transactions within Tatum Private
- Ledger. A transaction is performed between 2 accounts with the same currency.
- To perform an exchange operation between accounts with different currencies, API
- calls from Order Book sections
- are available. Transactions in the ledger are instant, with a settlement time
- of below 200ms.
+ "
+ name: Account
+ - description:
+ '
An endpoint used to create and list transactions within Tatum Private
+ Ledger. A transaction is performed between 2 accounts with the same currency.
+ To perform an exchange operation between accounts with different currencies, API
+ calls from Order Book sections
+ are available. Transactions in the ledger are instant, with a settlement time
+ of below 200ms.
- Tatum Private Ledger supports microtransactions - a transaction of an amount as
- little as 1e-30 (30 decimal places). Transactions are atomic.
+ Tatum Private Ledger supports microtransactions - a transaction of an amount as
+ little as 1e-30 (30 decimal places). Transactions are atomic.
- When there is an insufficient balance in the sender account, or recipient account
- cannot receive funds, the transaction is not settled.
An endpoint used to handle customer operations, like updating customer - information, enabling/disabling etc. + ' + name: Transaction + - description: + "
An endpoint used to handle customer operations, like updating customer
+ information, enabling/disabling etc.
- Within Tatum API, a customer represents a client of the entity that communicates
- with Tatum.
+ Within Tatum API, a customer represents a client of the entity that communicates
+ with Tatum.
- Customers cannot be created via any other operation than Create Ledger Account.
+ Customers cannot be created via any other operation than Create Ledger Account.
- Due to compliance restrictions, it is recommended to enter the country of residence
- of the customer and the country of the provider. The Tatum compliance engine operates
- based on this information.
+ Due to compliance restrictions, it is recommended to enter the country of residence
+ of the customer and the country of the provider. The Tatum compliance engine operates
+ based on this information.
-
Register and use Tatum Private Ledger''s virtual currencies. You
- can create your own virtual currency and distribute it amongst your customers.
+ "
+ name: Customer
+ - description:
+ "
Register and use Tatum Private Ledger's virtual currencies. You
+ can create your own virtual currency and distribute it amongst your customers.
- Virtual currencies are used to support FIAT currencies. When a virtual currency
- is created with basePair of the FIAT currency, it is possible to perform transactions
- in the private ledger in FIAT.
+ Virtual currencies are used to support FIAT currencies. When a virtual currency
+ is created with basePair of the FIAT currency, it is possible to perform transactions
+ in the private ledger in FIAT.
-
Endpoint to handle Order book operations like creating BID / ASK - trades between Tatum Private Virtual accounts, obtaining trade histories, creating - futures etc. It is possible to build an exchange based on the Ledger Accounts.
- name: Order Book -- description: 'Manage deposit addresses associated with your virtual account.
+ " + name: Virtual Currency + - description: +Endpoint to handle Order book operations like creating BID / ASK + trades between Tatum Private Virtual accounts, obtaining trade histories, creating + futures etc. It is possible to build an exchange based on the Ledger Accounts.
+ name: Order Book + - description: + "Manage deposit addresses associated with your virtual account.
-Depending on how virtual accounts are connected to the blockchain, the virtual - accounts can be:
+Depending on how virtual accounts are connected to the blockchain, the virtual + accounts can be:
-An endpoint to handle operations between a virtual account and - the blockchain, e.g. to create blockchain transactions from virtual accounts, - create custom fungible tokens and custom assets, and register them as a regular - currency into the virtual account.
+ " + name: Blockchain addresses + - description: + "An endpoint to handle operations between a virtual account and + the blockchain, e.g. to create blockchain transactions from virtual accounts, + create custom fungible tokens and custom assets, and register them as a regular + currency into the virtual account.
- ' - name: Blockchain operations + " + name: Blockchain operations servers: -- url: https://api.tatum.io + - url: https://api.tatum.io paths: /v3/ledger/account: post: @@ -406,3 +413,7 @@ paths: /v3/offchain/algorand/transfer: post: $ref: categories/virtual_accounts/paths/v3_offchain_algorand_transfer_post.yml +components: + securitySchemes: + X-API-Key: + $ref: components/schemas.yml#/components/securitySchemes/X-API-Key