Enables users to manage their Vonage API Account by programmable means. More information is available here: <https://developer.nexmo.com/account/overview.
Bring your own key. This API needs your own Account API key - get one from the provider, add it once below, and the proxy injects it on every call. Your OmniStream plan covers the unified SDK, key storage, and proxy - the provider's own rate limits still apply to your key.
This is a community listing. If you own this API, you can request ownership.
npm install omnistream-sdkimport { OmniClient } from "omnistream-sdk";
const omni = new OmniClient({ token: process.env.OMNI_KEY! });
// One key reaches every API on the marketplace.
const data = await omni.call("nexmo/getAccountBalance");One install, one key - the same client calls every API on the marketplace.
Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)
Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)
Get Account Balance
Register an email sender
Change Account Settings
Top Up Account Balance
Retrieve API Secrets
/**
* AccountAPI - generated by OmniStream from Account API's OpenAPI spec.
* One typed method per endpoint. A single Omni key reaches the API.
*/
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/nexmo";
export class AccountAPIError extends Error {
status: number;
code?: string;
constructor(status: number, code: string | undefined, message?: string) {
super(message || `AccountAPI error ${status}`);
this.name = "AccountAPIError";
this.status = status;
this.code = code;
}
}
export interface AccountAPIOptions {
baseUrl?: string;
fetch?: typeof fetch;
timeoutMs?: number;
}
export class AccountAPI {
/** @param token Your OmniStream key (one key for every API). */
constructor(private token: string, private opts: AccountAPIOptions = {}) {
if (!token) throw new Error("AccountAPI: token is required");
}
rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;
private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
const f = this.opts.fetch ?? globalThis.fetch;
const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
const headers: Record<string, string> = { "x-omni-key": this.token };
if (body !== undefined) headers["content-type"] = "application/json";
const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
this.rateLimit = {
remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
};
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new AccountAPIError(res.status, data?.error?.code, data?.error?.message);
return data.data ?? data;
}
/** Get Account Balance */
getAccountBalance(params: { "api_key": string; "api_secret": string }): Promise<any> {
return this._request("GET", "/account/get-balance", { params });
}
/** Register an email sender */
registerSender(body: unknown, params: { "api_key": string; "api_secret": string }): Promise<any> {
return this._request("POST", "/account/register-sender", { body, params });
}
/** Change Account Settings */
changeAccountSettings(params: { "api_key": string; "api_secret": string }): Promise<any> {
return this._request("POST", "/account/settings", { params });
}
/** Top Up Account Balance */
topUpAccountBalance(params: { "api_key": string; "api_secret": string }): Promise<any> {
return this._request("POST", "/account/top-up", { params });
}
/** Retrieve API Secrets */
retrieveAPISecrets(params: { "api_key": string }): Promise<any> {
return this._request("GET", "/accounts/{api_key}/secrets", { params });
}
/** Create API Secret */
createAPISecret(body: unknown, params: { "api_key": string }): Promise<any> {
return this._request("POST", "/accounts/{api_key}/secrets", { body, params });
}
/** Retrieve one API Secret */
retrieveAPISecret(params: { "api_key": string; "secret_id": string }): Promise<any> {
return this._request("GET", "/accounts/{api_key}/secrets/{secret_id}", { params });
}
/** Revoke an API Secret */
revokeAPISecret(params: { "api_key": string; "secret_id": string }): Promise<any> {
return this._request("DELETE", "/accounts/{api_key}/secrets/{secret_id}", { params });
}
}
export default AccountAPI;
No reviews yet. Be the first to rate this API.
Yes. Account API uses basic authentication, so you bring your own key from the provider. You store it once on OmniStream and the proxy injects it into every call, so your code only ever sends your Omni key.
Enables users to manage their Vonage API Account by programmable means. More information is available here: <https://developer.nexmo.com/account/overview. It exposes 8 endpoints over GET, POST, DELETE, including GET /account/get-balance, POST /account/register-sender, POST /account/settings.
Install the OmniStream SDK for your language and call Account API through it. The client is generated from this API's OpenAPI spec, so parameters and responses are fully typed, and the same client also calls every other API in the marketplace.
You can start on the free plan. OmniStream charges for the unified SDK, key storage and proxy rather than for Account API itself, and Account API's own rate limits still apply to your provider key.
QuickChart: An API to generate charts and QR codes using QuickChart services.
Create API Secret
Retrieve one API Secret
Revoke an API Secret