Sismo Docs
  • Welcome to Sismo
    • What is Sismo?
  • Build with Sismo Connect
    • Overview
    • Installation
    • Sismo Connect Cheatsheet
    • Tutorials
      • Get Your appId - Create a Sismo Connect App
      • Onchain Tutorial (1/2): Code Your Airdrop Contract With Privately-Aggregated Data
      • Onchain Tutorial (2/2): Deploy Your Airdrop Contract
    • Technical Documentation
      • Sismo Connect Configuration
      • Auths
      • Claims
      • Signature
      • Packages
        • Sismo Connect Client: Request
        • Sismo Connect React: Request
        • Sismo Connect Server: Verify Offchain
        • Sismo Connect Solidity Library: Verify Onchain
    • FAQ
  • Data Groups
    • Overview
    • Tutorials
      • Factory Guide: Create a Data Group in 5 Minutes
      • Sismo Hub Guide: Create Data Groups Programmatically
      • Sismo Hub Guide: Add a Data Provider to the Sismo Factory
    • Sismo Hub
      • Sismo Hub Repository
        • Group Generators
        • Data Providers
        • Data Operators
        • Command Line Interface
      • Accounts Registry Tree
  • Data Vault
    • Overview
    • Vault Identifiers
    • Proving Schemes
      • Hydra-S1
      • Hydra-S2
    • Commitment Mapper
  • Resources
    • Deployed Contract Addresses
    • Sismo API
      • API Links
      • Query From a Client
      • Group
        • Get groups
        • Get group snapshots
      • Common Parameters
      • Advanced Filtering
      • Transaction
  • Links
    • Sismo Landing Page
    • Sismo Factory
    • Sismo App Store
    • Sismo Builder Resources
    • GitHub
    • Discord
    • Twitter
    • Blog
Powered by GitBook
On this page
  1. Resources
  2. Sismo API

Common Parameters

PreviousGet group snapshotsNextAdvanced Filtering

Last updated 1 year ago

All our queries follow the same pattern.

Parameters when querying a list

All parameters are optional.

  • skip: Where to start pagination. Default: 0.

  • first: The number of items to query. Default: 100.

  • orderBy: The key of the item used to sort them.

  • orderDirection: asc or desc. Default: asc.

  • where: All fields can be used to operate .

Example: query the first 10 MintedBadges ordered by level

query {
  mintedBadges(first: 10, orderBy: level) {
    level
    badge {
      tokenId
    }
  }
}

Parameters when querying one item

Only the id is mandatory.

  • id: The id of the item to query

Example with the id "10000009-polygon-0xf61cabba1e6fc166a66bca0fcaa83762edb6d4bd"

In English, it would mean: "query the Minted Badge with the tokenId 10000009 for the address 0xf61cabba1e6fc166a66bca0fcaa83762edb6d4bd on Polygon."

query {
  mintedBadge(
    id: "10000026-polygon-0xf61cabba1e6fc166a66bca0fcaa83762edb6d4bd",
  ) {
    level
    badge {
      tokenId
    }
  }
}
advance queries