Synthetix Docs
  • User Docs
  • Synthetix Exchange
  • Leveraged Tokens
  • For Developers
  • Orientation
  • Synthetix Overview
  • Development Progress
  • V3 FAQ
  • For Developers
    • Technical Architecture
    • Quick Start
      • Base Quickstart
    • Smart Contracts
    • Data Platform
    • Data Dictionary
    • Addresses + ABIs
    • Deployment Info
      • Mainnet
      • Sepolia
      • Sepolia Carina
      • Optimism Mainnet
      • Base Mainnet Andromeda
      • Base Sepolia Andromeda
      • Arbitrum Mainnet
      • Arbitrum Sepolia
    • Smart Contract Audits
    • Perps Market
    • Spot Market
    • Developer FAQ
  • For Perp Integrators
    • 101
    • Perps V3
    • L1 Perp (BFP)
    • Base Andromeda
    • Perps Python SDK
    • Perps V3 Keepers
  • For Liquidity Integrators
    • Creating Accounts
    • Delegating Collateral
      • Liquidity Pools
    • Liquidity Positions
      • Minting and Burning snxUSD
      • Position Liquidations
    • Base LP Guide
  • For Liquidity Pool Managers
    • Creating and Configuring Pools and Vaults
    • Collateral Vaults
      • Vault Liquidations
    • Rewards Distributors
    • Credit and Debt Distribution
  • For Derivatives Market Builders
    • Build on v3
    • Market Development Guide
    • Build on v3 FAQ
    • Operating a Market
    • Registering a Market
  • For Governance Participants
    • Synthetix Governance
    • Elections
  • For Designers
    • Design Resources
Powered by GitBook
On this page
  • Intro
  • The Services
  • Running an Instance
  1. For Developers

Data Platform

Learn about the services Synthetix uses to collect, store, aggregate, and visualize data related to activity on Synthetix V3.

PreviousSmart ContractsNextData Dictionary

Last updated 1 year ago

Intro

The Synthetix repository contains a collection of services that collect raw data, clean and aggregate that data, and create helpful visualizations to understand activity on Synthetix V3. You can visit a hosted instance of the resulting .

The Services

A number of services are required to create a complete view of the historical data and produce these dashboards. The linked github repo contains the technical documentation for standing the services up to run an instance of this database and dashboard yourself. The services are:

  • A postgres database

  • One subsquid indexer for each chain

  • Scripts for collecting data using RPC calls

  • Dbt models for data cleaning, transformation, and aggregation

  • A streamlit dashboard for visualization

Running an Instance

These services are relatively lightweight and do not require massive amounts of storage. It is possible to run the entire service locally on most modern consumer hardware, given you have access to archive RPC nodes for each blockchain.

The repo has a Docker compose file detailing these services and their configurations. Users can choose to comment out certain services. For example, a user may choose to disable indexers for certain chains, or disable the dashboard to simply run a historical database as the backend for an API.

For more details or to ask more questions about running an instance, you can ask in the #dev-portal channel in the Synthetix discord.

Data Stack
Streamlit dashboard