/functions/rest/v1/functions/{id}/call REST Method

Path Parameters

id

string

REQUIRED

Function ID

Query Parameters

result_only

boolean

Set this parameter to true to return only the function's result. If you want to return all the activation details, omit this parameter.

Body Parameters

network

string

The network to pass into this function. ENUM: "arbitrum-mainnet", "arbitrum-sepolia", "avalanche-fuji", "avalanche-mainnet", "base-mainnet", "base-sepolia", "bera-bartio", "blast-mainnet", "blast-sepolia", "bnbchain-mainnet", "bnbchain-testnet", "celo-mainnet", "cyber-mainnet", "cycber-sepolia", "ethereum-holesky", "ethereum-mainnet", "ethereum-sepolia", "fantom-mainnet", "fraxtal-mainnet", "gnosis-mainnet", "imx-mainnet", "imx-testnet", "mantle-mainnet", "mantle-sepolia", "mode-mainnet", "nova-mainnet", "optimism-mainnet", "optimism-sepolia", "polygon-mainnet", "polygon-amoy", "scroll-mainnet", "scroll-testnet", "solana-devnet", "solana-mainnet", "solana-testnet", "tron-mainnet", "xai-mainnet", "xai-sepolia", "zkevm-mainnet", "zksync-mainnet", "zksync-sepolia", "zora-mainnet"

dataset

string

The dataset to pass into this function. ENUM: "block", "block_with_receipts", "receipts", "logs", "transactions", "trace_blocks", "debug_traces", "block_with_receipts_debug_trace", "block_with_receipts_trace_block", "programs_with_logs"

block_number

integer

The block number to pass into this function

user_data

object

A json object containing key-value pairs of data to pass into this function. Example: "key": "value"

Returns

id

string

The ID of the function activation.

created_at

string

The timestamp when the function was created.

updated_at

string

The timestamp when the function was updated.

name

string

The name of the function.

dataset

string

The name of the dataset.

network

string

The name of the network.

execution

object

The response returned by the function which contains the following fields:

result

object

It contains the outcome of the function execution.

size

integer

The size in bytes of the result returned by the function.

memory

integer

The memory allocated to execute function.

duration

integer

The duration of function execution.

status_code

integer

The status code of the function activation.

logs

array

The logs generated by the function.

user_data

object

The user data passed into the function.

block_number

integer

The block number passed into the function.

activation_source

string

The source of the function activation.

Request

curl -X POST \
    "https://api.quicknode.com/functions/rest/v1/functions/{id}/call" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-api-key: YOUR_API_KEY" \
    -d $'{
  "network": "ethereum-mainnet",
  "dataset": "block",
  "block_number": 19532341,
  "user_data": {
    "key": "value"
  }
}'
    

var myHeaders = new Headers();
myHeaders.append('accept', 'application/json');
myHeaders.append('Content-Type', 'application/json');
myHeaders.append('x-api-key', 'YOUR_API_KEY'); // Replace with your actual API key

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  redirect: 'follow',
  body: JSON.stringify({
    network: 'ethereum-mainnet',
	dataset: 'block',
	block_number: 19532341,
	user_data: {
		key: 'value'
	}
  })
};

fetch('https://api.quicknode.com/functions/rest/v1/functions/{id}/call/result_only=true', requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests

url = "https://api.quicknode.com/functions/rest/v1/functions/{id}/call?result_only=True"  # Replace {id} with your actual namespace ID

payload = {
   "network": "ethereum-mainnet",
    "dataset": "block",
    "block_number": 19532341,
    "user_data": {
        "key": "value"
  }
}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY"  # Replace with your actual API key
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

require "uri"
require "net/http"
require "json"

# Set up the URL for the request
url = URI("https://api.quicknode.com/functions/rest/v1/functions/call?result_only=true")  # Replace {id} with your actual namespace ID

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["Content-Type"] = "application/json"
request["x-api-key"] = "YOUR_API_KEY"  # Replace with your actual API key

request.body = {
  "network" => "ethereum-mainnet",
  "dataset" => "block",
  "block_number" => 19532341,
  "user_data" => {
    "key" => "value"
  }
}.to_json

response = https.request(request)
puts response.body

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free