Vulcan Forge API
  1. Trades
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
          POST
      • 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. Trades

Trade

Developing
Development
https://vf-solana-api.dev.alphaledger.com
Development
https://vf-solana-api.dev.alphaledger.com
POST
/api/v1/positions/trade
Processes the array of position movements as an atomic Solana transaction. See each of the endpoints for the different position movements types for how each one functions and what signers are required.
Visit the API Endpoint doc for each position movement for details on the signers needed on each operation and the behavior of the unfreeze / freeze options.
If the trade request has these characteristics:
the trade level freeze and/or unfreeze options turned on
a mix of of operations on both SPL and TOKEN_2022 tokens (or some of the TOKEN_2022 financial instruments do not have freeze authorities setup for them)
then the freeze authority lookup and request will fail. In these scenarios, the unfreeze and freeze flags should be used at the operation level to turn off these options on operations for tokens that do not have a freeze authority setup for them. Use the Fetch Financial Instrument Details endpoint to find out if a freeze authority is setup for a financial instrument.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created
application/json
Body

🟠400
🟠401
🟠403
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://vf-solana-api.dev.alphaledger.com/api/v1/positions/trade?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemData": {
        "operations": [
            {
                "mint": {
                    "mintTo": {
                        "position": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "owner": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "financialInstrument": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "mintAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "freezeAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        }
                    },
                    "value": {
                        "amount": 3.8097,
                        "lamports": 8733302
                    },
                    "memo": "string",
                    "unfreeze": false,
                    "freeze": false
                },
                "burn": {
                    "burnFrom": {
                        "position": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "owner": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "financialInstrument": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "mintAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "freezeAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        }
                    },
                    "value": {
                        "amount": 3.8097,
                        "lamports": 8733302
                    },
                    "memo": "string",
                    "unfreeze": false,
                    "freeze": false,
                    "offchainBalanceAvailabilityPrecheck": true,
                    "burnEntireBalance": false,
                    "signWithPermanentDelegate": false,
                    "permanentDelegateAuthority": {
                        "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                        "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                        "offchainReferences": {
                            "alId": "ALFNDPF000153778",
                            "organizationExternalId": "ALT",
                            "accountNumber": "ALT10000233",
                            "code": "some-authority",
                            "type": "WALLET"
                        },
                        "autoSign": true,
                        "otherTenantOrganizationExternalId": "ALIM",
                        "offPlatform": false
                    }
                },
                "transfer": {
                    "source": {
                        "position": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "owner": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "financialInstrument": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "mintAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "freezeAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        }
                    },
                    "destination": {
                        "position": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "owner": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "financialInstrument": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "mintAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        },
                        "freezeAuthority": {
                            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                            "offchainReferences": {
                                "alId": "ALFNDPF000153778",
                                "organizationExternalId": "ALT",
                                "accountNumber": "ALT10000233",
                                "code": "some-authority",
                                "type": "WALLET"
                            },
                            "autoSign": true,
                            "otherTenantOrganizationExternalId": "ALIM",
                            "offPlatform": false
                        }
                    },
                    "value": {
                        "amount": 3.8097,
                        "lamports": 8733302
                    },
                    "memo": "string",
                    "unfreezeSource": false,
                    "freezeSource": false,
                    "unfreezeDestination": false,
                    "freezeDestination": false,
                    "offchainBalanceAvailabilityPrecheck": true,
                    "transferEntireBalance": false,
                    "initializeDestinationPositionIfNeeded": false,
                    "signWithPermanentDelegate": false,
                    "permanentDelegateAuthority": {
                        "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                        "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                        "offchainReferences": {
                            "alId": "ALFNDPF000153778",
                            "organizationExternalId": "ALT",
                            "accountNumber": "ALT10000233",
                            "code": "some-authority",
                            "type": "WALLET"
                        },
                        "autoSign": true,
                        "otherTenantOrganizationExternalId": "ALIM",
                        "offPlatform": false
                    }
                },
                "transferNetworkCurrency": {
                    "source": {
                        "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                        "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                        "offchainReferences": {
                            "alId": "ALFNDPF000153778",
                            "organizationExternalId": "ALT",
                            "accountNumber": "ALT10000233",
                            "code": "some-authority",
                            "type": "WALLET"
                        },
                        "autoSign": true,
                        "otherTenantOrganizationExternalId": "ALIM",
                        "offPlatform": false
                    },
                    "destination": {
                        "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                        "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                        "offchainReferences": {
                            "alId": "ALFNDPF000153778",
                            "organizationExternalId": "ALT",
                            "accountNumber": "ALT10000233",
                            "code": "some-authority",
                            "type": "WALLET"
                        },
                        "autoSign": true,
                        "otherTenantOrganizationExternalId": "ALIM",
                        "offPlatform": false
                    },
                    "value": {
                        "amount": 3.8097,
                        "lamports": 8733302
                    },
                    "takeSourceBalanceToMinimumRent": false,
                    "memo": "string",
                    "offchainBalanceAvailabilityPrecheck": true
                }
            }
        ],
        "idempotencyId": "10c44604-1458-46b2-906e-61fce2633485",
        "memo": "string",
        "unfreeze": false,
        "freeze": false,
        "offchainBalanceAvailabilityPrecheck": true
    },
    "svmTransactionConfig": {
        "feePayer": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {
                "alId": "ALFNDPF000153778",
                "organizationExternalId": "ALT",
                "accountNumber": "ALT10000233",
                "code": "some-authority",
                "type": "WALLET"
            },
            "autoSign": true,
            "otherTenantOrganizationExternalId": "ALIM",
            "offPlatform": false
        },
        "computeUnitConfig": {
            "enable": true,
            "limit": 0,
            "price": 0,
            "priceEstimate": {
                "provider": "HELIUS",
                "calculationStrategy": "DEFAULT",
                "priorityLevel": "RECOMMENDED"
            }
        },
        "commitmentConfig": {
            "commitmentLevel": "processed"
        },
        "messageLifetimeStrategy": "RECENT_BLOCKHASH",
        "transactionVersion": "V0"
    },
    "tenancyConfig": {
        "overrideOrganizationExternalId": "ALIM"
    }
}'
Response Response Example
201 - Example 1
{
    "success": false,
    "offchainId": "ee36c656-aa74-4d6a-b23c-332c204cb202",
    "status": "SIGNED",
    "onchainId": "5nwo7XvhiVRpJasEzH5r3hGKJqaTxd7qVit3cedFJgESdAPrmawebMJu6fUKRfjXEaivuey7vBsW56xPxX76T1bm",
    "confirmationsCount": 2,
    "serializedMessage": "string",
    "errorMessage": "string",
    "txnTimestamp": "2025-10-21T16:17:45.035372Z"
}
Modified at 2026-02-21 22:00:42
Previous
Trades
Next
History
Built with