Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rarible User balances API

The User balances API from Rarible — 1 operation(s) for user balances.

Rarible User balances API is one of 18 APIs that Rarible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v0.1.

Requests are made against a single base URL, https://{environment}.rarible.org.

1 operations 1 paths 8 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v0.1
Base URL
https://api.rarible.org/v0.1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rarible User balances API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

User balances 1
GET
/v0.1/balances/{currencyId}/{owner}
Get balance
getBalance 2 params → 200404400500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Balance (4 properties), UnionApiErrorEntityNotFound (2 properties), UnionApiErrorBadRequest (2 properties), UnionApiErrorServerError (2 properties). Each schema is shown below with its type and property counts.

UnionApiErrorServerError
object
2 properties 2 required
CurrencyId
string
Currency Id, has format ETHEREUM:${token} or ETHEREUM:${token}:${tokenId}
UnionAddress
string
Blockchain address in Union format ${blockchainGroup}:${token}
BigDecimal
string
UnionApiErrorBadRequest
object
2 properties 2 required
BigInteger
string
UnionApiErrorEntityNotFound
object
2 properties 2 required
Balance
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rarible-user-balances-api-openapi.yml Raw ↑

Other APIs Rarible publishes across the network.

Rarible Charts API
Rarible Collection Leader Board API
Rarible Collection Statistics API
Rarible Currencies and rates API
Rarible Domain lookup API
Rarible Encode operations API
Rarible Indexer blocks API
Rarible NFT Activities API
Rarible NFT Collections API
Rarible NFT Data and Historical Statistics API
Rarible NFT Items API
Rarible NFT Ownerships API