OpenAPI (Swagger) definitions

Heimdahl.xyz Blockchain data indexing API

REST and Websocket API Specification .

Version: 0.0.1

Terms of service

https://heimdahl.xyz

Contact information: Heimdahl.xyz sypport https://heimdahl.xyz [e-mail]

License: Commercial

OpenAPI

Security

Bearer

apiKey	API Key
In	header
Name	Authorization

/v1/{chain}/blocks

GET

Summary:

Get Blocks

Description:

Retrieve block information for a specific blockchain network

Parameters

Name	Located in	Description	Required	Schema
chain	path	Blockchain network (e.g., ethereum, bsc)	Yes	string

Responses

Code	Description	Schema
200	OK	node.BlockResponse
400	Bad Request	string
404	Not Found	string
500	Internal Server Error	string

/v1/{chain}/events/{address}/{event}

GET

Summary:

Get Events

Description:

Retrieve events for a specific contract and chain

Parameters

Name	Located in	Description	Required	Schema
chain	path	Blockchain network (e.g., Ethereum, Binance Smart Chain)	Yes	string
address	path	Contract address	Yes	string
event	path	Event name or type	Yes	string

Responses

Code	Description	Schema
200	OK	node.EventsResponse
400	Bad Request	string
404	Not Found	string
500	Internal Server Error	string

/v1/{chain}/nfts/{owner}

GET

Summary:

List nfts by owner

Description:

List nfts by owner

Parameters

Name	Located in	Description	Required	Schema
chain	path	Chain identifier	Yes	string
owner	path	Owner address	Yes	string

Responses

Code	Description	Schema
200	OK	[ types.NFTDetails ]
500	Internal Server Error	string

/v1/chains

GET

Summary:

Get Chains

Description:

Retrieve chain information for a specific blockchain network

Responses

Code	Description	Schema
200	OK	[ types.Chain ]
400	Bad Request	string
404	Not Found	string
500	Internal Server Error	string

/v1/chains/{chain}

GET

Summary:

Show Chain

Description:

Retrieve chain information for a specific chain

Parameters

Name	Located in	Description	Required	Schema
chain	path	Chain identifier	Yes	string

Responses

Code	Description	Schema
200	OK	types.Chain
400	Bad Request	string
404	Not Found	string
500	Internal Server Error	string

/v1/contracts

GET

Summary:

List contracts

Description:

List contracts

Responses

Code	Description	Schema
200	OK	[ node.ContractResponse ]
201	Created	string
401	Unauthorized	string
500	Internal Server Error	string

POST

Summary:

Add EVM Contract

Description:

Add EVM contract for indexing

Responses

Code	Description	Schema
200	OK	string
201	Created	string
401	Unauthorized	string
500	Internal Server Error	string

/v1/contracts/{address}

GET

Summary:

Show contract

Description:

Show EVM contract info

Parameters

Name	Located in	Description	Required	Schema
address	path	Contract Address	Yes	string

Responses

Code	Description	Schema
200	OK	node.ContractResponse
201	Created	string
401	Unauthorized	string
500	Internal Server Error	string

/v1/stats

GET

Summary:

Get stats for the indexer

Description:

Retrieve stats for the indexer

Responses

Code	Description	Schema
200	OK	string
400	Bad Request	string
404	Not Found	string
500	Internal Server Error	string

Models

big.Int

Name	Type	Description	Required
big.Int	object

github_com_nozim_heimdahl_xyz_types.Block

Name	Type	Description	Required
difficulty	string		No
extraData	string		No
gasLimit	integer		No
gasUsed	integer		No
hash	string		No
logsBloom	string		No
miner	string		No
mixHash	string		No
nonce	integer		No
number	string		No
parentHash	string		No
receiptsRoot	string		No
sha3Uncles	string		No
size	integer		No
stateRoot	string		No
timestamp	integer		No
transactions	[ string ]		No
transactionsRoot	string		No
uncles	[ string ]		No

node.BlockResponse

Name	Type	Description	Required
blocks	[ github_com_nozim_heimdahl_xyz_types.Block ]		No
meta	node.BlockResponseMeta		No

node.BlockResponseMeta

Name	Type	Description	Required
chain	string		No
page	integer		No
per_page	integer		No
total	integer		No

node.ContractResponse

Name	Type	Description	Required
chain	string		No
contract_address	string		No
contract_name	string		No
events	string		No
network	string		No

node.EventDetails

Name	Type	Description	Required
node.EventDetails	object

node.EventResponseMeta

Name	Type	Description	Required
addresss	string		No
chain	string		No
chain_id	integer		No
event	string		No
page	integer		No
per_page	integer		No
total	integer		No

node.EventsResponse

Name	Type	Description	Required
events	[ node.EventDetails ]		No
meta	node.EventResponseMeta		No

types.Chain

Name	Type	Description	Required
chain_id	integer		No
chain_name	string		No
chain_network	string		No

types.NFTDetails

Name	Type	Description	Required
block_number	integer		No
collection_address	string		No
owner	string		No
token_id	big.Int		No