# Vulcan Forge API ## Docs - [Introduction](https://vulcan-forge-docs.alphaledger.com/introduction.md): - [Getting Started](https://vulcan-forge-docs.alphaledger.com/getting-started.md): - [Authentication & Authorization](https://vulcan-forge-docs.alphaledger.com/authentication-and-authorization.md): - Core Concepts [Terminology](https://vulcan-forge-docs.alphaledger.com/core-concepts/terminology.md): - Core Concepts [Regulated Assets](https://vulcan-forge-docs.alphaledger.com/core-concepts/regulated-assets.md): - Core Concepts [Tenants](https://vulcan-forge-docs.alphaledger.com/core-concepts/tenants.md): - Core Concepts [Mapping & Labelling](https://vulcan-forge-docs.alphaledger.com/core-concepts/mapping-and-labelling.md): - Core Concepts [SVM Networks](https://vulcan-forge-docs.alphaledger.com/core-concepts/svm-networks.md): - Core Concepts [Transaction Processing](https://vulcan-forge-docs.alphaledger.com/core-concepts/transaction-processing.md): - Core Concepts [Key Management](https://vulcan-forge-docs.alphaledger.com/core-concepts/key-management.md): - Core Concepts [Read Layer](https://vulcan-forge-docs.alphaledger.com/core-concepts/read-layer.md): - [API Reference](https://vulcan-forge-docs.alphaledger.com/api-reference-6466772f0.md): - API Reference [Blockchain Accounts](https://vulcan-forge-docs.alphaledger.com/blockchain-accounts-6466773f0.md): Endpoints for managing and reading Vulcan Forge Accounts. - API Reference [Financial Instruments](https://vulcan-forge-docs.alphaledger.com/financial-instruments-6466774f0.md): - API Reference [Positions](https://vulcan-forge-docs.alphaledger.com/api/v1/positions.md): - API Reference > Positions [State](https://vulcan-forge-docs.alphaledger.com/state-6466779f0.md): - API Reference > Positions [Movements](https://vulcan-forge-docs.alphaledger.com/movements-6466780f0.md): - API Reference > Positions [Trades](https://vulcan-forge-docs.alphaledger.com/trades-6466781f0.md): - API Reference > Positions [History](https://vulcan-forge-docs.alphaledger.com/history-6466782f0.md): - API Reference [Loans](https://vulcan-forge-docs.alphaledger.com/loans-6466776f0.md): - API Reference > Market Data [Onchain Data Sources](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources.md): - API Reference [Blockchain Transactions](https://vulcan-forge-docs.alphaledger.com/blockchain-transactions-6466778f0.md): Transactions submission, signing and configurations. - API Reference > Blockchain Transactions [Processing](https://vulcan-forge-docs.alphaledger.com/processing-6466784f0.md): Endpoints for viewing missing signatures, signing prepared transactions, submitting prepared transactions and resubmitting transactions that errored out. - API Reference > Blockchain Transactions [Durable Nonces](https://vulcan-forge-docs.alphaledger.com/durable-nonces-6466785f0.md): Configure nonce authorities and nonce accounts. - API Reference > Blockchain Transactions [Address Lookup Tables](https://vulcan-forge-docs.alphaledger.com/address-lookup-tables-6466786f0.md): ## API Docs - API Reference > Blockchain Accounts [Create Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/create.md): Creates/onboards a Solana Account on the Vulcan Forge system and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the account into Vulcan Forge but not submit a Solana transaction to create the account on the network (because the account would already be on the network). - API Reference > Blockchain Accounts [Fetch Account Details](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch/single.md): Fetches the details for a single blockchain account. - API Reference > Blockchain Accounts [Fetch Account Private Key](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch/private-key.md): Fetches the private key for an account. Requires elevated permissions - the API key needs to be associated with the VULCAN_FORGE_SENSITIVE_DATA_ACCESS role to fetch this data. - API Reference > Blockchain Accounts [Fetch Account Balance](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch/balance.md): Fetches the current (offchain and/or onchain) or a past (offchain) SOL/lamports balances for an account. - API Reference > Blockchain Accounts [Fetch Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch/bulk.md): Fetches a list of accounts based on the provided query. Please note that the output fields will be trimmed to a smaller set of fields if the _detail-level_ path parameter is set to _identifiers_ or _compact_. Available detail levels: - API Reference > Blockchain Accounts [Update Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/update.md): Update certain attributes on the specified account. This functions as a patch. Only fields specified in the request body will be updated. The rest of the fields already present on the account remain unchanged. - API Reference > Blockchain Accounts [Inactivate Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/inactivate.md): Closes the Account in Solana and it inactivates it on Alphaledger's platform. It refunds remaining network currency to the desired destination (if provided) otherwise the refund goes to the configured fee payer in the svmTransactionConfig (or the global fee payer, if the fee payer is not supplied in the svmTransactionConfig). - API Reference > Financial Instruments [Create Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/create.md): Creates/onboards a financial instrument on the Vulcan Forge platform and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the financial instrument into Vulcan Forge but not submit a Solana transaction to create the financial instrument on the network (because the token/financial instrument is already full setup on the network). - API Reference > Financial Instruments [Fetch Financial Instrument Details](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/fetch/single.md): Fetches the details for a single fetch financial instrument. - API Reference > Financial Instruments [Fetch Financial Instrument Circulating Supply](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/fetch/circulating-supply.md): Fetches the circulating supply for the financial instrument. - API Reference > Financial Instruments [Fetch Financial Instruments](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/bulk.md): Fetches a list of financial instruments based on the provided query. Please note that the output fields will be trimmed to a smaller set of fields if the _detail-level_ path parameter is set to _identifiers_ or _compact_. Available detail levels: - API Reference > Financial Instruments [Update Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/update.md): Updates for a financial instrument. - API Reference > Financial Instruments [Close Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/close.md): Close a financial instrument and reclaim network currency rent. Requires the existence of a close authority associated with the mint. - API Reference > Financial Instruments [Pause Financial Instrument](https://vulcan-forge-docs.alphaledger.com/pause-financial-instrument-28463428e0.md): Pause activity on the financial instrument. Applies only to TOKEN_2022 financial instruments and requires the pausable authority to be configured. - API Reference > Financial Instruments [Unpause Financial Instrument](https://vulcan-forge-docs.alphaledger.com/unpause-financial-instrument-28463659e0.md): Unpause activity on the financial instrument. Applies only to TOKEN_2022 financial instruments and requires the pausable authority to be configured. - API Reference > Financial Instruments [Token Extensions Calculator](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/token-extension-calculator.md): Calculates the following inputs needed to setup a new mintAccount: - API Reference > Positions > State [Initialize Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/initialize.md): It creates a position offchain and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the position into Vulcan Forge but not submit a Solana transaction to create the position/token account on the network (because the token account would already be on the network). - API Reference > Positions > State [Update Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/update.md): Endpoint to be used for changing offchain attributes associated with the position. If an attribute is specified in the request body, the value of that field will be changed. Atribtues that are not specified will have the same values they had before. - API Reference > Positions > State [Inactivate Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/inactivate.md): Inactivates the Token Account / Position in the SVM Cluster and on the Vulcan Forge platform. It refunds remaining network currency to the desired destination: the feePayer or a provided itemData.refundDestination wallet. - API Reference > Positions > State [Freeze Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/freeze.md): Freezes the Token Account / Position in Solana to prevent any position movements to be posted against this position.. Some text. - API Reference > Positions > State [Unfreeze Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/unfreeze.md): Unfreezes the Token Account / Position in Solana to allow position movements against this position.. - API Reference > Positions > Movements [Mint](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/mint.md): Mints the specified amount into the mintTo position. The position needs to be unfrozen. - API Reference > Positions > Movements [Burn](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/burn.md): Burns the specified amount from the burnFrom position. The position needs to be unfrozen and have a sufficient balance to support the burn. - API Reference > Positions > Movements [Transfer Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/transfer.md): Transfer the specified amount from the source position to the destination position. The financial instrument on the 2 positions needs to match. The source position needs to have a sufficient balance to support the transfer and has to be unfrozen. - API Reference > Positions > Movements [Transfer Network Currency](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/transfer-network-currency.md): Transfer the specified amount of network currency (e.g. SOL). The source account needs to have a sufficient balance to support the transfer. - API Reference > Positions > Trades [Trade](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/trade.md): Processes the array of position movements as an atomic Solana transaction. See each of [the endpoints](/api/v1/positions/movements) for the different position movements types for how each one functions and what signers are required. - API Reference > Positions > History [Fetch Position Details](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/fetch/single.md): - API Reference > Positions > History [Fetch Position Balance](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/fetch/balance.md): Fetches the current (offchain and/or onchain) or past (offchain) token balances (as a amount and amount in lamports - i.e. amount multiplied by 10^token decimals) for an account. - API Reference > Positions > History [Fetch Positions](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/fetch/bulk.md): Fetches a list of positions based on the provided query. Please note that the output fields will be trimmed to a smaller set of fields if the _detail-level_ path parameter is set to _identifiers_ or _compact_. Available detail levels: - API Reference > Loans [Create Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/create.md): Creates a loan and establishes a new onchain escrow wallet for it. The pledged items are deposited into this escrow and the borrowed items are transferred from the lender to the fee payer. - API Reference > Loans [Fetch Loan Details](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/fetch/single.md): Gets details associated with a single onchain loan. - API Reference > Loans [Fetch Loans](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/fetch/bulk.md): Fetches a list of loans based on the provided query. - API Reference > Loans [Swap Collateral](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/swap-collateral.md): Swaps a set of collateral items (referred to as deposited collateral) against another set of collateral items (referred to as withdrawn collateral). - API Reference > Loans [Repay Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/repay.md): Repays a loan. Use the itemsToRepay to specify the items from the borrower wallet to payoff the debts with and the itemsToRelease to specify what items to release from the loan back to the borrower wallet. - API Reference > Loans [Close Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/close.md): Closes a loan and it refunds the rent fee network currency from the onchain loan back to the borrower's wallet. - API Reference > Loans [Refinance Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/refinance.md): Refinance / rollover an existing loan. If the fromLender and toLender are the same, the toLender does not need to be specified - in this case the endpoint just does a new rollover of the existing loan using the market rates in place at the time the request is executed. - API Reference > Market Data > Onchain Data Sources [Create Onchain Data Source](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources/create.md): Creates an onchain data source (feed) provided through an Oracle and: - API Reference > Market Data > Onchain Data Sources [Update Oracle Data Source Definition](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources/update.md): Udpates an onchain data source (feed). This request is processed as a patch operation: the fields provided in the request payload will replace existing data; the rest of the fields associated with this provider remain unchanged. - API Reference > Market Data > Onchain Data Sources [Refresh Oracle Data Source](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources/refresh.md): Refreshes the onchain data for this data source with the newest data from the offchain location where it originates from. - API Reference > Market Data > Onchain Data Sources [Fetch Onchain Data Source Details](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources/fetch/single.md): Fetches the details for a single onchain data source. - API Reference > Market Data > Onchain Data Sources [Fetch Oracle Data Sources](https://vulcan-forge-docs.alphaledger.com/api/v1/onchain-data-sources/fetch/bulk.md): Fetches a list of onchain data sources based on the provided query. - API Reference > Blockchain Transactions > Processing [Fetch Transaction Status](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/fetch/status.md): - API Reference > Blockchain Transactions > Processing [Sign Transaction](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/sign.md): - API Reference > Blockchain Transactions > Processing [Submit Transaction](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/submit.md): - API Reference > Blockchain Transactions > Durable Nonces [Create Durable Nonce Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/durable-nonces/create.md): Creates one or moe durable nonce account to be added to the pool of durable nonce accounts that can be used for processing transactions with a messageLifetimeStrategy of DURABLE_NONCE. Go to [Transaction Processing](https://vulcan-forge-docs.alphaledger.com/core-concepts/transaction-processing#durable-nonces) for additional details. - API Reference > Blockchain Transactions > Durable Nonces [Fetch Durable Nonce Account Details](https://vulcan-forge-docs.alphaledger.com/api/v1/durable-nonces/fetch/single.md): - API Reference > Blockchain Transactions > Durable Nonces [Fetch Durable Nonce Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/durable-nonces/fetch/bulk.md): Fetches available nonce accounts that have been setup. - API Reference > Blockchain Transactions > Address Lookup Tables [Create Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/address-lookup-table/create.md): Creates an [Address Lookup Table](https://solana.com/developers/guides/advanced/lookup-tables). Please note that once component addresses are added to an address lookup table, they cannot be removed from it. - API Reference > Blockchain Transactions > Address Lookup Tables [Fetch Address Lookup Table Details](https://vulcan-forge-docs.alphaledger.com/api/v1/address-lookup-table/fetch/single.md): Fetches details for a single address lookup table - API Reference > Blockchain Transactions > Address Lookup Tables [Fetch Address Lookup Tables](https://vulcan-forge-docs.alphaledger.com/api/v1/address-lookup-table/fetch/bulk.md): Fetches a list of account lookup tables that meet the query criteria. - API Reference > Blockchain Transactions > Address Lookup Tables [Extend Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/address-lookup-table/extend.md): Extends the address lookup table by adding new addresses to the existing list. - API Reference > Blockchain Transactions > Address Lookup Tables [Update Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/address-lookup-table/update.md): Updates the address lookup table (ALT) to manage its lifecycle. Only applies to address lookup tables that are managed on the platform. - API Reference > Blockchain Transactions > History [Fetch Transaction Details](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/fetch/single.md): - API Reference > Blockchain Transactions > History [Fetch Transactions](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/fetch/bulk.md): ## Schemas - Accounts > DKG [DKG Key Setup](https://vulcan-forge-docs.alphaledger.com/dkg-key-setup-12773413d0.md): - Accounts [Max Allowed Debit Config](https://vulcan-forge-docs.alphaledger.com/max-allowed-debit-config-12827705d0.md): - Accounts [Offchain References](https://vulcan-forge-docs.alphaledger.com/offchain-references-12773403d0.md): - Accounts [Account Lookup](https://vulcan-forge-docs.alphaledger.com/account-lookup-12773404d0.md): - Accounts [New Account](https://vulcan-forge-docs.alphaledger.com/new-account-12773405d0.md): - Accounts [Tenancy Config](https://vulcan-forge-docs.alphaledger.com/tenancy-config-12773406d0.md): - Accounts [Offchain File](https://vulcan-forge-docs.alphaledger.com/offchain-file-12773408d0.md): - Accounts [Network Currency Debit Limit Config](https://vulcan-forge-docs.alphaledger.com/network-currency-debit-limit-config-12773410d0.md): - Accounts [Token Debit Limit Config](https://vulcan-forge-docs.alphaledger.com/token-debit-limit-config-12773411d0.md): - Accounts [Limit Duration](https://vulcan-forge-docs.alphaledger.com/limit-duration-12773412d0.md): - Transactions [Svm Value Input](https://vulcan-forge-docs.alphaledger.com/svm-value-input-12775957d0.md): - Transactions [Svm Transaction Config](https://vulcan-forge-docs.alphaledger.com/svm-transaction-config-12773414d0.md): - Transactions [Commitment Config](https://vulcan-forge-docs.alphaledger.com/commitment-config-12773415d0.md): - Transactions [Transaction Lookup](https://vulcan-forge-docs.alphaledger.com/transaction-lookup-12773416d0.md): - Query > Query Components [Sort Model](https://vulcan-forge-docs.alphaledger.com/sort-model-12773419d0.md): - Query > Query Components [Filter Model](https://vulcan-forge-docs.alphaledger.com/filter-model-12773420d0.md): - Query > Query Components [Field Value Filter](https://vulcan-forge-docs.alphaledger.com/field-value-filter-12773421d0.md): - Query [Items Query](https://vulcan-forge-docs.alphaledger.com/items-query-12773417d0.md): - Query [Bulk Query](https://vulcan-forge-docs.alphaledger.com/bulk-query-12773418d0.md): - Loans [Loan Duration](https://vulcan-forge-docs.alphaledger.com/loan-duration-12773422d0.md): - Reponses > Errors [Individual Error](https://vulcan-forge-docs.alphaledger.com/individual-error-12773423d0.md): - Reponses > Errors [Error Response](https://vulcan-forge-docs.alphaledger.com/error-response-12773424d0.md): - Reponses > Accounts > Private Keys [Database Private Key Details](https://vulcan-forge-docs.alphaledger.com/database-private-key-details-12773432d0.md): - Reponses > Accounts > Private Keys [Private Key Details](https://vulcan-forge-docs.alphaledger.com/private-key-details-12773433d0.md): - Reponses > Accounts > Private Keys [Cloud Provider Resource Location](https://vulcan-forge-docs.alphaledger.com/cloud-provider-resource-location-12773434d0.md): - Reponses > Accounts > Private Keys [DKG Private Key Details](https://vulcan-forge-docs.alphaledger.com/dkg-private-key-details-12773435d0.md): - Reponses > Accounts [Account Response Detailed](https://vulcan-forge-docs.alphaledger.com/account-response-detailed-12773425d0.md): - Reponses > Accounts [Account Onchain Detailed](https://vulcan-forge-docs.alphaledger.com/account-onchain-detailed-12773426d0.md): - Reponses > Accounts [Account Offchain Detailed](https://vulcan-forge-docs.alphaledger.com/account-offchain-detailed-12773427d0.md): - Reponses > Accounts [Account Response Compact](https://vulcan-forge-docs.alphaledger.com/account-response-compact-12773428d0.md): - Reponses > Accounts [Account Onchain Compact](https://vulcan-forge-docs.alphaledger.com/account-onchain-compact-12773429d0.md): - Reponses > Accounts [Account Offchain Compact](https://vulcan-forge-docs.alphaledger.com/account-offchain-compact-12773430d0.md): - Reponses > Accounts [Account Response Identifiers](https://vulcan-forge-docs.alphaledger.com/account-response-identifiers-12773431d0.md): - Reponses > Transactions [Svm Value Result](https://vulcan-forge-docs.alphaledger.com/svm-value-result-12776927d0.md): - Reponses > Transactions [Svm Transaction Result](https://vulcan-forge-docs.alphaledger.com/svm-transaction-result-12773436d0.md): - Reponses > Transactions [Svm Entity Result](https://vulcan-forge-docs.alphaledger.com/svm-entity-result-12773437d0.md): - Reponses > Financial Instruments [Financial Instrument Detailed](https://vulcan-forge-docs.alphaledger.com/financial-instrument-detailed-12773438d0.md): - Reponses > Financial Instruments [Financial Instrument Compact](https://vulcan-forge-docs.alphaledger.com/financial-instrument-compact-12773439d0.md): - Reponses > Financial Instruments [Financial Instrument Identifiers](https://vulcan-forge-docs.alphaledger.com/financial-instrument-identifiers-12773440d0.md): - Reponses > Loans [Loan Response](https://vulcan-forge-docs.alphaledger.com/loan-response-12773441d0.md): - Reponses > Positions [Position Offchain Result](https://vulcan-forge-docs.alphaledger.com/position-offchain-result-12773442d0.md): - Reponses > Positions [Position Balance Response](https://vulcan-forge-docs.alphaledger.com/position-balance-response-12773443d0.md): - Reponses > Positions [Position Response Detailed](https://vulcan-forge-docs.alphaledger.com/position-response-detailed-12773444d0.md): - Reponses > Positions [Position Response Compact](https://vulcan-forge-docs.alphaledger.com/position-response-compact-12773445d0.md): - Reponses > Positions [Position Response Identifiers](https://vulcan-forge-docs.alphaledger.com/position-response-identifiers-12773446d0.md): - Reponses > Market Data [Onchain Data Source Response](https://vulcan-forge-docs.alphaledger.com/onchain-data-source-response-12773447d0.md): - Positions [Position Lookup](https://vulcan-forge-docs.alphaledger.com/position-lookup-12773448d0.md): - Positions [Mint Definition](https://vulcan-forge-docs.alphaledger.com/mint-definition-12773449d0.md): - Positions [Burn Definition](https://vulcan-forge-docs.alphaledger.com/burn-definition-12773450d0.md): - Positions [Transfer Financial Instrument Definition](https://vulcan-forge-docs.alphaledger.com/transfer-financial-instrument-definition-12773451d0.md): - Positions [Transfer Network Currency Definition](https://vulcan-forge-docs.alphaledger.com/transfer-network-currency-definition-12773452d0.md): - Market Data [Onchain Data Source Details](https://vulcan-forge-docs.alphaledger.com/onchain-data-source-details-12773455d0.md): - Market Data [Switchboard Data Source Details](https://vulcan-forge-docs.alphaledger.com/switchboard-details-12773456d0.md):