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

R2 collections API

The collections API from R2 — 2 operation(s) for collections.

R2 collections API is one of 8 APIs that R2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against 2 base URLs: https://gateway-dev.r2capital.co:443/v2, https://gateway-dev.r2capital.co/v2/.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://gateway-dev.r2capital.co/v2/
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

R2 collections API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (JWT).

Paths & Operations 3

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

collections 3
GET
/collections/{id}
Show a collection by its id as filtering key.
1 param → 200400404500
GET
/collections/
Show all collections.
7 params → 200400404500
POST
/collections/
Add one or more collections.
body → 201400404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are domain.Collection (21 properties), domain.CollectionRequest (7 properties), domain.CollectionResponse (6 properties), domain.Data (4 properties). Each schema is shown below with its type and property counts.

domain.Collection
object
21 properties
domain.CollectionResponse
object
6 properties
domain.CollectionRequest
object
7 properties 6 required
domain.Data
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

r2-collections-api-openapi.yml Raw ↑

Other APIs R2 publishes across the network.

R2 callbacks API
R2 events API
R2 financings API
R2 merchants API
R2 payments API
R2 Sandbox API
R2 transactions API