Squads Docs
Development
Development
  • Introduction
    • What is Squads Protocol
    • Use Cases
    • Quickstart
  • Typescript
    • Overview
    • Instructions
      • Create Multisig
      • Create Config Transaction
      • Create Vault Transaction
      • Create Proposal
      • Approve Proposal
      • Reject Proposal
      • Cancel Proposal
      • Execute Config Transaction
      • Execute Vault Transaction
      • Create Batch
      • Add To Batch
      • Close Vault Transaction Account
      • Controlled Multisig Instructions
        • Add Member
        • Remove Member
        • Set Rent Collector
        • Add spending limit
        • Remove Spending Limit
    • Accounts
      • Multisig
      • Vault
      • Transactions
      • Proposal
      • Batch
  • Reference
    • Accounts
    • Permissions
    • Spending Limits
    • Time-locks
    • SDKs
    • Controlled Multisigs
  • API
    • Vault Check
  • CLI
    • Installation
    • Commands
  • Get Support
    • We're here to help
  • Other
    • Migrating from MultisigCreate v1 to v2
    • Squads Actions and Blinks
Powered by GitBook
On this page
  1. API

Vault Check

Check if a given address maps to a Squad vault.

This endpoint allows the caller to specify a Solana address and return whether or not that address is a valid Squads V3 or V4 vault account, and can receive funds.

Endpoint:

https://4fnetmviidiqkjzenwxe66vgoa0soerr.lambda-url.us-east-1.on.aws/isSquad/<ADDRESS>

Example Request:

https://4fnetmviidiqkjzenwxe66vgoa0soerr.lambda-url.us-east-1.on.aws/isSquad/HFwi9HgNtFcMwNJPHa1czrPhuxeZFZ7G9tPQ1LqAd7sy

Example Response:

{
  “isSquad”: true,
  “version”: "v4“
}

isSquad denotes whether the given address is a valid Squads vault or not. True means it is a valid V3 or V4 vault account.

version denotes which Squads program version the vault is from, if it is a valid vault. This will return V3, V4, or an empty string if isSquad is false.

Important Notes:

  • This endpoint does not check for ATA (associated token account) validity. IF SENDING SPL TOKENS, YOU MUST CHECK THIS SEPARATELY.

  • There is a rate limit of 25 RPS.

  • Do not expose the endpoint URL on your frontend. Either use SSR, or proxy the endpoint through a server you control.

  • If possible, cache responses to your own infrastructure to avoid polling the endpoint for the same addresses again and again.

PreviousControlled MultisigsNextInstallation

Last updated 8 months ago