API reference

Use the API reference when you already know which dblurt capability you need and want exact details: classes, methods, options, return values, overloads and deprecation notes.

If you are still deciding what to use, start with Choose your path. If you want a task-oriented flow, use Recipes.

Start here by goal

Goal	Learn the workflow	API details
Create a client and choose endpoints	Getting started	Client, ClientOptions
Choose a helper namespace	Choose your path	Client
Read Layer 1 data	Read chain data	Client.condenser, Client.database, Client.blockchain
Read Nexus social/indexed data	Use Nexus social data	Nexus, NexusRankedPostsQuery, NexusAccountPostsQuery
Use high-level read models	Read models	ReadModels, AccountReadModel, VoteValueReadModel
Build content operations	Build post operation	buildPostOperation, PostOperationOptions
Classify errors	Handle retryable errors	classifyError, DBlurtErrorMetadata
Validate authorities	Accounts and authorities	validatePostingAuthority, validateAccountAuthority
Sign and broadcast	Broadcast safely	Client.broadcast

What to use this page for

Use this page as a bridge from concepts and recipes to exact API details.

Good reasons to open an API symbol page:

• checking the exact option names for a method;
• confirming return types;
• finding overloads;
• checking whether an API is deprecated;
• following source links while debugging;
• verifying exported types for TypeScript code.

Keep concepts and API details separate

Concept pages explain how to think about Blurt and dblurt. Recipes show how to complete tasks. API symbol pages answer precise questions about a class, function, method or type.

When in doubt:

Still learning the feature?  Read Learn or Guides.
Trying to complete a task?  Use Recipes.
Need exact signatures?      Use API reference.