Vulcan Forge API
  1. API Reference
Vulcan Forge API
  • Introduction
  • Getting Started
  • Authentication & Authorization
  • Core Concepts
    • Terminology
    • Regulated Assets
    • Tenants
    • Mapping & Labelling
    • SVM Networks
    • Transaction Processing
    • Key Management
    • Read Layer
  • API Reference
    • Blockchain Accounts
      • Create Account
      • Fetch Account Details
      • Fetch Account Private Key
      • Fetch Account Balance
      • Fetch Accounts
      • Update Account
      • Inactivate Account
    • Financial Instruments
      • Create Financial Instrument
      • Fetch Financial Instrument Details
      • Fetch Financial Instrument Circulating Supply
      • Fetch Financial Instruments
      • Update Financial Instrument
      • Close Financial Instrument
      • Pause Financial Instrument
      • Unpause Financial Instrument
      • Token Extensions Calculator
    • Positions
      • State
        • Initialize Position
        • Update Position
        • Inactivate Position
        • Freeze Position
        • Unfreeze Position
      • Movements
        • Mint
        • Burn
        • Transfer Financial Instrument
        • Transfer Network Currency
      • Trades
        • Trade
      • History
        • Fetch Position Details
        • Fetch Position Balance
        • Fetch Positions
    • Loans
      • Create Loan
      • Fetch Loan Details
      • Fetch Loans
      • Swap Collateral
      • Repay Loan
      • Close Loan
      • Refinance Loan
    • Market Data
      • Onchain Data Sources
        • Create Onchain Data Source
        • Update Oracle Data Source Definition
        • Refresh Oracle Data Source
        • Fetch Onchain Data Source Details
        • Fetch Oracle Data Sources
    • Blockchain Transactions
      • Processing
        • Fetch Transaction Status
        • Sign Transaction
        • Submit Transaction
      • Durable Nonces
        • Create Durable Nonce Accounts
        • Fetch Durable Nonce Account Details
        • Fetch Durable Nonce Accounts
      • Address Lookup Tables
        • Create Address Lookup Table
        • Fetch Address Lookup Table Details
        • Fetch Address Lookup Tables
        • Extend Address Lookup Table
        • Update Address Lookup Table
      • History
        • Fetch Transaction Details
        • Fetch Transactions
  • Schemas
    • Accounts
      • DKG
        • DKG Key Setup
      • Max Allowed Debit Config
      • Offchain References
      • Account Lookup
      • New Account
      • Tenancy Config
      • Offchain File
      • Network Currency Debit Limit Config
      • Token Debit Limit Config
      • Limit Duration
    • Transactions
      • Svm Value Input
      • Svm Transaction Config
      • Commitment Config
      • Transaction Lookup
    • Query
      • Query Components
        • Sort Model
        • Filter Model
        • Field Value Filter
      • Items Query
      • Bulk Query
    • Loans
      • Loan Duration
    • Reponses
      • Errors
        • Individual Error
        • Error Response
      • Accounts
        • Private Keys
          • Database Private Key Details
          • Private Key Details
          • Cloud Provider Resource Location
          • DKG Private Key Details
        • Account Response Detailed
        • Account Onchain Detailed
        • Account Offchain Detailed
        • Account Response Compact
        • Account Onchain Compact
        • Account Offchain Compact
        • Account Response Identifiers
      • Transactions
        • Svm Value Result
        • Svm Transaction Result
        • Svm Entity Result
      • Financial Instruments
        • Financial Instrument Detailed
        • Financial Instrument Compact
        • Financial Instrument Identifiers
      • Loans
        • Loan Response
      • Positions
        • Position Offchain Result
        • Position Balance Response
        • Position Response Detailed
        • Position Response Compact
        • Position Response Identifiers
      • Market Data
        • Onchain Data Source Response
    • Positions
      • Position Lookup
      • Mint Definition
      • Burn Definition
      • Transfer Financial Instrument Definition
      • Transfer Network Currency Definition
    • Market Data
      • Onchain Data Source Details
      • Switchboard details
    • Loans
  1. API Reference

Financial Instruments

Create Financial Instrument
POST/api/v1/financial-instruments
Creates/onboards a financial instrument on the Vulcan Forge platform and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onbo...
Fetch Financial Instrument Details
POST/api/v1/financial-instruments/single
Fetches the details for a single fetch financial instrument.
Fetch Financial Instrument Circulating Supply
POST/api/v1/financial-instruments/single/circulating-supply
Fetches the circulating supply for the financial instrument. the onchain value: current value of the circulating supply on the SVM network the offcha...
Fetch Financial Instruments
POST/api/v1/financial-instruments/bulk/{detail-level}
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 ...
Update Financial Instrument
PATCH/api/v1/financial-instruments
Updates for a financial instrument.
Close Financial Instrument
PATCH/api/v1/financial-instruments/close
Close a financial instrument and reclaim network currency rent. Requires the existence of a close authority associated with the mint. The circulating ...
Pause Financial Instrument
PATCH/api/v1/financial-instruments/pause
Pause activity on the financial instrument. Applies only to TOKEN_2022 financial instruments and requires the pausable authority to be configured.
Unpause Financial Instrument
PATCH/api/v1/financial-instruments/unpause
Unpause activity on the financial instrument. Applies only to TOKEN_2022 financial instruments and requires the pausable authority to be configured.
Token Extensions Calculator
POST/api/v1/financial-instruments/token-extensions-calculator
Calculates the following inputs needed to setup a new mintAccount: the mint account size in bytes the amount of rent Factors (inputs) taken in this ...
Previous
Inactivate Account
Next
Create Financial Instrument
Built with