LogoLogo
SDKAPI
Next
Next
  • Learn
    • Introduction
      • Obol Collective
      • OBOL Incentives
      • Key Staking Concepts
      • Obol vs Other DV Implementations
      • Obol Splits
      • DV Launchpad
      • Frequently Asked Questions
    • Charon
      • Introduction to Charon
      • Distributed Key Generation
      • Cluster Configuration
      • Charon Networking
      • CLI Reference
    • Futher Reading
      • Ethereum and Its Relationship With DVT
      • Community Testing
      • Peer Score
      • Useful Links
  • Run a DV
    • Quickstart
      • Quickstart Overview
      • Create a DV Alone
      • Create a DV With a Group
      • Push Metrics to Obol Monitoring
    • Prepare to Run a DV
      • How and Where To Run DVs
      • Deployment Best Practices
      • Test a Cluster
    • Running a DV
      • Activate a DV
      • Update a DV
      • Monitoring Your Node
      • Claim Rewards
      • Exit a DV
    • Partner Integrations
      • Create an EigenLayer DV
      • Create a Lido CSM DV
      • DappNode
  • Advanced & Troubleshooting
    • Advanced Guides
      • Create a DV Using the SDK
      • Migrate an Existing Validator
      • Enable MEV
      • Combine DV Private Key Shares
      • Self-Host a Relay
      • Advanced Docker Configs
      • Beacon node authentication
    • Troubleshooting
      • Errors & Resolutions
      • Handling DKG Failure
      • Client Configuration
      • Test Commands
    • Security
      • Overview
      • Centralization Risks and Mitigation
      • Obol Bug Bounty Program
      • Smart Contract Audit
      • Software Development at Obol
      • Charon Threat Model
      • Contacts
  • Community & Governance
    • Governance
      • Collective Overview
      • The Token House
      • The RAF
      • The OBOL Token
      • Delegate Guide
      • RAF1 Guide
    • Community
      • Staking Mastery Program
      • Techne
    • Contribution & Feedback
      • Filing a Bug Report
      • Documentation Standards
      • Feedback
  • Walkthrough Guides
    • Walkthroughs
      • Walkthrough Guides
  • SDK
    • Intro
    • Enumerations
      • FORK_MAPPING
    • Classes
      • Client
    • Interfaces
      • ClusterDefinition
      • RewardsSplitPayload
    • Type-Aliases
      • BuilderRegistration
      • BuilderRegistrationMessage
      • ClusterCreator
      • ClusterLock
      • ClusterOperator
      • ClusterPayload
      • ClusterValidator
      • DepositData
      • DistributedValidator
      • ETH_ADDRESS
      • OperatorPayload
      • SplitRecipient
      • TotalSplitPayload
    • Functions
      • validateClusterLock
  • API
    • What is this API?
    • System
    • Metrics
    • Cluster Definition
    • Cluster Lock
    • State
    • DV Exit
    • Cluster Effectiveness
    • Terms And Conditions
    • Techne Credentials
    • Address
    • OWR Information
  • Specification
Powered by GitBook
On this page
Edit on GitHub
  1. API

Address

PreviousTechne CredentialsNextOWR Information

Last updated 2 months ago

Retrieve obol techne credentials of an address

get

This endpoint is used to retrieve obol techne credentials an address owns

Path parameters
addressstringRequired

The address to check the techne credentials for.

Responses
200
The address techne credentials object
application/json
Responseany of
400
The Address provided is not valid
500
An unknown error occurred
get
GET //v1/address/techne/{address} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "base": [
    "text"
  ],
  "bronze": [
    "text"
  ],
  "silver": [
    "text"
  ],
  "gold": [
    "text"
  ]
}

Retrieve badges for an address

get

This endpoint is used to retrieve the badges an address owns

Path parameters
addressstringRequired

The address to check the techne credentials for.

Responses
200
The address techne credentials object
application/json
Responseany of
400
The Address provided is not valid
500
An unknown error occurred
get
GET //v1/address/badges/{address} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "badges": [
    "text"
  ]
}

Retrieve operators on a given network

get

This endpoint fetches a number of operators for a given network.

Path parameters
networkstringRequired

The network to retrieve operators on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}
Query parameters
pageintegerRequired

The page number to retrieve.

Default: 0
limitintegerRequired

The number of operators to return.

Default: 100
sortBystringOptional

numerical field to sort by

Default: active_validators_count
sortOrderstringOptional

order of sorting the field

Default: desc
detailsstringRequired

The flag to populate operators information.

Default: false
Responses
200
A paged list of Operators on this network
application/json
Responseany of
400
Network not spported
500
An unknown error occurred
get
GET //v1/address/network/{network} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "operators": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

Retrieve a list operators on a given network

get

This endpoint is used to search for operators that match a substring of their address.

Path parameters
networkstringRequired

The network to retrieve operators on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}
Query parameters
partialAddressstringRequired

A substring of the address of Operator.

pageintegerRequired

The page number to retrieve.

Default: 0
limitintegerRequired

The number of operators to return.

Default: 100
Responses
200
A paged list of Operators on this network
application/json
Responseany of
404
Operators not found
500
An unknown error occurred
get
GET //v1/address/search/{network} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "operators": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}
  • GETRetrieve obol techne credentials of an address
  • GETRetrieve badges for an address
  • GETRetrieve operators on a given network
  • GETRetrieve a list operators on a given network