API Documentation

The function and event signature database exposes a RESTful API that is provided free to use by anyone without restriction.

Authentication

There is no authentication necessary to access this API

Endpoint

Endpoint for data fetching: https://api.signature.nima.enterprises

1. [GET] /api/events

Description: Retrieve a list of events.

Response:

{
	"status": "ok",
	"events": [
		{
			"text_signature": "secureMint(bytes,uint256,uint256)",
			"bytes_signature": "0x9509af0690b1bcf6f757a9ea3d7cf7807be479dfad151bb798b00737fc63ae72"
		},
		{
			"text_signature": "revokeBurnerAddress(address)",
			"bytes_signature": "0xba8bce555aeefb6d13f423ae2e5ba41ccada4b5fc89ab24401bdd4ad522eaa6c"
		},
		{
			"text_signature": "registerBurnerAddress(address)",
			"bytes_signature": "0x4b45793570251b6a7ae4084efb6dfa55a1a79c0fbdcd53431a3cd96ffd6cde2d"
		},
		{
			"text_signature": "publicMax()",
			"bytes_signature": "0xe527c6ddc27724a942ef495775695b916e42acf4b6210923d68ff1f6c2d8bbcd"
		},
		{
			"text_signature": "publicLive()",
			"bytes_signature": "0xb7f751d85c94486f870e3af6399197fc8498480fa7b9bb506779358c3f6632d1"
		}
	]
}

2. [GET] /api/events?from_page=1

Description: Retrieve a paginated list of events starting from page 1.

Response:

{
	"status": "ok",
	"events": [
		{
			"text_signature": "secureMint(bytes,uint256,uint256)",
			"bytes_signature": "0x9509af0690b1bcf6f757a9ea3d7cf7807be479dfad151bb798b00737fc63ae72"
		},
		{
			"text_signature": "revokeBurnerAddress(address)",
			"bytes_signature": "0xba8bce555aeefb6d13f423ae2e5ba41ccada4b5fc89ab24401bdd4ad522eaa6c"
		},
		{
			"text_signature": "registerBurnerAddress(address)",
			"bytes_signature": "0x4b45793570251b6a7ae4084efb6dfa55a1a79c0fbdcd53431a3cd96ffd6cde2d"
		},
		{
			"text_signature": "publicMax()",
			"bytes_signature": "0xe527c6ddc27724a942ef495775695b916e42acf4b6210923d68ff1f6c2d8bbcd"
		},
		{
			"text_signature": "publicLive()",
			"bytes_signature": "0xb7f751d85c94486f870e3af6399197fc8498480fa7b9bb506779358c3f6632d1"
		}
	]
}

3. [GET]/api/events/{{signature}}

Description: Retrieve details for a specific event.

Response:

{
	"status": "ok",
	"event": {
		"text_signature": "schedulerAddress()",
		"bytes_signature": "0xae45850b"
	}
}

4. [GET] /api/signatures

Description: Retrieve a list of signatures.

Response:

{
	"status": "ok",
	"signatures": [
		{
			"text_signature": "balanceOf(address)",
			"bytes_signature": "0x722713f7",
			"hex_signature": "0x722713f7"
		},
		{
			"text_signature": "transfer(address,uint256)",
			"bytes_signature": "0xabcd1234",
			"hex_signature": "0xabcd1234"
		}
	]
}

5: [GET] /api/signatures?from_page=1

Description: Retrieve a paginated list of signatures starting from page 1.

Response:

{
	"status": "ok",
	"signatures": [
		{
			"text_signature": "balanceOf(address)",
			"bytes_signature": "0x722713f7",
			"hex_signature": "0x722713f7"
		},
		{
			"text_signature": "transfer(address,uint256)",
			"bytes_signature": "0xabcd1234",
			"hex_signature": "0xabcd1234"
		}
		// ... additional signatures
	]
}

6: [GET] /api/signatures/{{signature}}

Description: Retrieve details for a specific signature.

Response:

{
	"status": "ok",
	"signature": {
		"text_signature": "schedulerAddress()",
		"bytes_signature": "0xae45850b",
		"hex_signature": "0xae45850b"
	}
}