fbpixel

API Documentation

Documentation for the ChainRecorder API
The Chainrecorder API allows you to securely generate and manage lists of hashes for your data. This is particularly useful for recording transactions, files, or any other type of data on the blockchain. The API is RESTful, uses JSON for requests and responses, and requires authentication via an API token.

Getting Started

To use the ChainRecorder API, you will need to obtain an API token from your profile page on the ChainRecorder platform. Once you have your API token, you can use it to make requests to the API. The API token should be included in the Authorization header of your requests.

Authorization Header

javascript 
// Authorization Header 
'Authorization': 'Bearer ' + {{CHAINRECORDER_API_KEY}}

API URL

javascript 
// API URL for all API requests 
const CHAINRECORDER_API_URL = 'https://mainnet.chainrecorder.com/v1'

Chaining Files

Get all Chains

javascript 
// Get all chains (hashes)
export const hashFile = async () => {
	try {
		const res = await fetch('{{CHAINRECORDER_API_URL}}/hashes', {
			method: 'GET',
			headers: {
				'Authorization': 'Bearer ' + {{CHAINRECORDER_API_KEY}},
			},
			mode: 'cors',
		})

		const json = await res.json()

		return json
	} catch (err) {
		throw error(err)
	}
}

Chain a File

javascript 
// Chain a file
export const hashFile = async () => {
	try {
		let fileBlob = '/path/to/file'
		const file = fileBlob.target.files[0]	
		const sanitizedFilename = file.name.replace(/s+/g, '_')
		const res = await fetch('{{CHAINRECORDER_API_URL}}/hashes', {
			method: 'POST',
			body: JSON.stringify({
				filename: sanitizedFilename,
				contentType: file.type,
				save_file: false, // Save the file to ChainRecorder?
			}),
			headers: {
				'Content-Type': 'application/json',
				'Authorization': 'Bearer ' + {{CHAINRECORDER_API_KEY}},
			},
			mode: 'cors',
		})

		const json = await res.json()

		return json
	} catch (err) {
		throw error(err)
	}
}