API

Every blocknative.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Gas

getBaseFeeEstimates

gas.getBaseFeeEstimates Get real-time base fee, blob base fee, and priority fee predictions for the next 5 Ethereum blocks Risk: read

await corsair.blocknative.api.gas.getBaseFeeEstimates({});

Input: empty object Output

Name	Type	Required	Description
`system`	`string`	Yes	—
`network`	`string`	Yes	—
`unit`	`string`	Yes	—
`currentBlockNumber`	`number`	No	—
`msSinceLastBlock`	`number`	No	—
`baseFeePerGas`	`number`	No	—
`blobBaseFeePerGas`	`number`	No	—
`estimatedBaseFees`	`object[]`	Yes	—

estimatedBaseFees full type

{
}[]

getDistribution

gas.getDistribution Retrieve the current mempool gas price distribution breakdown Risk: read

await corsair.blocknative.api.gas.getDistribution({});

Input

Name	Type	Required	Description
`chainid`	`number`	No	—

Output

Name	Type	Required	Description
`system`	`string`	Yes	—
`network`	`string`	Yes	—
`unit`	`string`	Yes	—
`maxPrice`	`number`	No	—
`currentBlockNumber`	`number`	No	—
`msSinceLastBlock`	`number`	No	—
`topNDistribution`	`object`	Yes	—

topNDistribution full type

{
  distribution: number[][],
  n: number
}

getOracles

gas.getOracles Retrieve metadata on supported gas oracles per chain Risk: read

await corsair.blocknative.api.gas.getOracles({});

Input: empty object Output

Name	Type	Required	Description
`oracles`	`object[]`	Yes	—

oracles full type

{
  arch?: string,
  chainId: number,
  label: string,
  icon?: string,
  system?: string,
  network?: string,
  addressByVersion?: {
  },
  rpcUrl?: string,
  blockExplorerUrl?: string
}[]

getPrices

gas.getPrices Fetch gas price estimates for specific inclusion probabilities (next block or ~10 seconds) Risk: read

await corsair.blocknative.api.gas.getPrices({});

Input

Name	Type	Required	Description
`chainid`	`number`	No	—
`system`	`string`	No	—
`network`	`string`	No	—
`confidenceLevels`	`number[]`	No	—

Output

Name	Type	Required	Description
`system`	`string`	Yes	—
`network`	`string`	Yes	—
`unit`	`string`	Yes	—
`maxPrice`	`number`	No	—
`currentBlockNumber`	`number`	No	—
`msSinceLastBlock`	`number`	No	—
`blockPrices`	`object[]`	Yes	—

blockPrices full type

{
  blockNumber: number,
  estimatedTransactionCount?: number,
  baseFeePerGas?: number | null,
  blobBaseFeePerGas?: number | null,
  estimatedPrices: {
    confidence: number,
    price: number,
    maxPriorityFeePerGas?: number | null,
    maxFeePerGas?: number | null
  }[]
}[]

getSupportedChains

gas.getSupportedChains Retrieve supported chains metadata for Blocknative gas services Risk: read

await corsair.blocknative.api.gas.getSupportedChains({});

Input: empty object Output

Name	Type	Required	Description
`chains`	`object[]`	Yes	—

chains full type

{
  arch?: string,
  chainId: number,
  label: string,
  icon?: string,
  system?: string,
  network?: string,
  features?: string[]
}[]

Overview

Plugins

Gas

getBaseFeeEstimates

getDistribution

getOracles

getPrices

getSupportedChains

​Gas

​getBaseFeeEstimates

​getDistribution

​getOracles

​getPrices

​getSupportedChains

Gas

getBaseFeeEstimates

getDistribution

getOracles

getPrices

getSupportedChains