How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ditto Store API

The Store API from Ditto — 5 operation(s) for store.

Ditto Store API is one of 7 APIs that Ditto publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Store. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 29 schemas. It is described by OpenAPI 3.0.3, at version 4.0.0.

Requests are made against a single base URL, {base_url}/api/v4.

5 operations 5 paths 29 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.0.0
Base URL
https://{app-id}.cloud.dittolive.app
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ditto Store API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key or JWT) (api_key_or_jwt_token). By default, every request must be authenticated.

  • api_key_or_jwt_token — Authentication using either an API key or JWT token in the Authorization header

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Store 5
POST
/store/count
Count the number of documents in a collection that match a specified query. This endpoint is useful for pagination, analytics, and understanding the size of your dataset.
count_endpoint 1 param body → 200400401500
POST
/store/execute
Execute a DQL query
execute_endpoint 1 param body → 200400401404408500503
POST
/store/find
Query documents in a collection using a flexible query language. This endpoint supports pagination, sorting, and complex queries to help you efficiently retrieve exactly the data you need.
find_endpoint 1 param body → 200400401500
POST
/store/findbyid
Retrieve a single document by its unique identifier. This is the most efficient way to fetch a specific document when you know its ID.
find_by_id_endpoint 1 param body → 200400401500
POST
/store/write
Perform one or more write operations (updates, upserts, or removals) in a single atomic transaction. This endpoint ensures all operations either succeed or fail together, maintaining data consistency.
write_endpoint 1 param body → 200400401403500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are FindRequest (9 properties), QueryResponse (7 properties), UpdateResult (5 properties), Update (4 properties). Each schema is shown below with its type and property counts.

Upsert
object
Command to insert a new document or update an existing one if it already exists
4 properties 2 required
UpdateCommandMethod
string
Types of update operations that can be performed on document fields
Remove
object
Command to remove documents or fields from a collection that match the specified query
3 properties 2 required
Direction
string
Sort direction for query results. Use 'asc' for ascending order (A to Z, 1 to 9) or 'desc' for descending order (Z to A, 9 to 1).
UpdateResult
object
Result of executing an update operation
5 properties 3 required
FindRequest
object
Request parameters for querying documents in a collection. Supports filtering, pagination, and sorting to help you retrieve exactly the data you need.
9 properties 2 required
QueryRequest
object
Request parameters for executing a DQL statement. DQL is Ditto's powerful query language that supports complex queries and data modifications.
2 properties 1 required
WriteCommand
A write operation to perform in a transaction. Can be an update, upsert, or remove command.
AnyValue
Update
object
Command to update existing documents in a collection that match a query
4 properties 3 required
FindByIdResponse
CountRequest
object
Request parameters for counting documents in a collection. Use this to get the total number of documents matching specific criteria.
3 properties 2 required
FindByIdRequest
object
Request parameters for retrieving a specific document by its ID. This is the most efficient way to fetch a single document when you know its identifier.
4 properties 2 required
QueryResponseWarning
object
Indicates any run-time warnings that might arise during query execution
2 properties 1 required
UpdateCommand
object
Specifies how to modify a field in matching documents
3 properties 3 required
Sort
object
Specifies how to sort query results by a property
2 properties 2 required
TypeOverride
string
Specifies special data types for fields when upserting documents
RemoveResult
object
Result of executing a remove operation
4 properties 2 required
QueryResponse
object
Response from executing a DQL statement. Contains query results, affected document IDs, and any warnings or errors that occurred.
7 properties 5 required
FindResponse
object
2 properties 1 required
Document
object
Represents a document in the Ditto store. Documents are schema-free and can contain nested fields of various CRDT types for conflict-free replication.
2 properties 2 required
WriteCommandResult
Result of executing a write command. Contains the specific result type based on the command method.
WriteRequest
object
Request to execute one or more write commands in a transaction
1 property 1 required
UpsertResult
object
Result of executing an upsert operation
1 property 1 required
WriteResponse
object
Response containing results of executing a write transaction
1 property 1 required
SerializedAs
string
Controls how document values are serialized in responses
QueryResponseError
object
An error occurred that prevented the query from executing or completing successfully
1 property
CountResponse
object
Response from a count operation, providing both the count and transaction ID for consistency tracking.
2 properties 2 required
RpcError
object
Error response returned when an API request fails
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ditto-live-store-api-openapi.yml Raw ↑

Other APIs Ditto publishes across the network.

Ditto SDK
Ditto API Keys API
Ditto Apps API
Ditto BigPeerReplication API
Ditto Data Bridge API
Ditto Sync API
Where this information came from

This is an independent, third-party profile of Ditto Store API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.