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

Nakama Friends API

Manage the friend graph.

Nakama Friends API is one of 11 APIs that Nakama publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, http://127.0.0.1:7350.

3 operations 1 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
http://127.0.0.1:7350/v2
Authentication
HTTP Basic, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nakama Friends API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic auth using the server key as the username and an empty password. Guards the authenticate endpoints.
  • BearerAuth — The JWT session token returned by an authenticate call, sent as Authorization: Bearer .

Paths & Operations 3

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

Friends 3

Manage the friend graph.

GET
/v2/friend
List all friends for the current user.
listFriends 3 params → 200
POST
/v2/friend
Add friends by ids or usernames.
addFriends 2 params → 200
DELETE
/v2/friend
Delete one or more friends for the current user.
deleteFriends 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (16 properties), Friend (3 properties), FriendList (2 properties). Each schema is shown below with its type and property counts.

FriendList
object
2 properties
User
object
A user in the system.
16 properties
Friend
object
A friend of a user.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nakama-friends-api-openapi.yml Raw ↑

Other APIs Nakama publishes across the network.

Nakama Realtime Socket API
Nakama Console API
Nakama Account API
Nakama Authentication API
Nakama Groups API
Nakama Leaderboards API
Nakama Notifications API
Nakama RPC API
Nakama Storage API
Nakama Tournaments API