API

Ordinals Wallet Api Documentation

API Url: https://turbo.ordinalswallet.com

Inscriptions

Fetch an inscription

GET https://turbo.ordinalswallet.com/inscription/:inscription_id

Fetch the location of an inscription

GET https://turbo.ordinalswallet.com/inscription/:inscription_id/outpoint

Fetch the raw content of an inscription

GET https://cdn.ordinalswallet.com/inscription/content/:inscription_id

Fetch an image preview of an inscription

GET https://cdn.ordinalswallet.com/inscription/preview/:inscription_id

Not all inscriptions are supported yet. When an image cannot be generated, the raw inscription content is returned

Collections

Types

pub struct Inscription {
    id: String,
    meta: Option<InscriptionMeta>,
}

pub struct InscriptionMeta {
    pub name: Option<String>,
    pub attributes: Option<Vec<InscriptionMetaAttribute>>,
}

pub struct InscriptionMetaAttribute {
    pub trait_type: String,
    pub value: String,
}

Create a collection

POST https://turbo.ordinalswallet.com/collection/new

Request Body

Name	Type	Description
api_secret*	String
name*	String	human readable name of the collection
icon_inscription_id	String	inscription id of the icon of the collection
icon*	String	url of the inscription icon
slug	String	unique collection slug
active*	bool	to show/hide the collection
description*	String
inscriptions*	Inscription[]	List of inscriptions in the collection
socials*	Json	{ "twitter": "", "discord": "", "website": "" }

Update a collection

POST https://turbo.ordinalswallet.com/collection/update

Update collection by creating a request with one or more optional parameter. There are three parameters that can be used to update collection inscriptions. The inscriptions parameter can be used to add and remove inscriptions. When given, it is considered the new state of the collection inscriptions. The new_inscriptions parameter can be used to add new inscriptions with metadata. The new_inscription_ids parameter can be used to add new inscriptions without metadata. These three parameters are meant to be used separately.

Request Body

Name	Type	Description
api_secret*	String
slug*	String	unique collection slug
name	String	human readable name of the collection
icon_inscription_id	String	inscription id of the icon of the collection (priority)
icon	String	url of the inscription icon
active	bool	to show/hide the collection
description	String
inscriptions	Inscription[]	List of inscriptions in the collection
socials	Json	{ "twitter": "", "discord": "", "website": "" }
remove_icon_inscription_id	bool	Delete icon_inscription_id
new_inscription_ids	String[]	List of new inscription ids to add to the collection
new_inscriptions	Inscription[]	List of new inscriptions to add to the collection

Fetch a collection

GET https://turbo.ordinalswallet.com/collection/:slug

List collection inscriptions

GET https://turbo.ordinalswallet.com/collection/:slug/inscriptions

List inscriptions that are for sale

GET https://turbo.ordinalswallet.com/collection/:slug/escrows

List inscriptions that sold

GET https://turbo.ordinalswallet.com/collection/:slug/sold-escrows

List attributes for a collection

GET https://turbo.ordinalswallet.com/collection/:slug/attributes

Fetch collection stats

GET https://turbo.ordinalswallet.com/collection/:slug/stats

Fetch collection snapshot

GET https://turbo.ordinalswallet.com/collection/:slug/snapshot

A list of all addresses that hold an item in the collection

Wallet

Wallet Balance

GET https://turbo.ordinalswallet.com/wallet/:address

Get the balance of a wallet. Includes bitcoin balance, inscriptions and brc20

Verify a signed message

POST https://turbo.ordinalswallet.com/wallet/:address/verify-message

Bip-0322 Signed Message Verification https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki

Request Body

Name	Type	Description
message*	String	the message that was signed
signature	String	base64 encoded signature