serverBanner

Overview

The server.banner method retrieves the server's banner message. This is typically used to display server-specific messages or announcements to users.

Parameters

No parameters are required for this method.

Returns

Upon a successful request, the server responds with its current banner message. The response's result field contains a string with the banner message.

Example Result

{
  "banner": "Welcome to Electrum Server!"
}

Request Example

curl --location 'https://api.tatum.io/v3/blockchain/node/bitcoin-mainnet-electrs/' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {API_KEY}' \
--data '{
    "method": "server.banner",
    "params": [],
    "id": 1,
    "jsonrpc": "2.0"
}'

// yarn add @tatumio/tatum

import { TatumSDK, BitcoinElectrs, Network } from '@tatumio/tatum'

const tatum = await TatumSDK.init<BitcoinElectrs>({ network: Network.BITCOIN_ELECTRS })

const serverBanner = await tatum.rpc.getServerBanner()

console.log(serverBanner)

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs