@yext/api

TypeScript Client for Yext APIs

A package that makes it easy to call Yext APIs from TypeScript and JavaScript. Currently covers just a few of the most popular endpoints.

Quick Start

Node.js and npm

This package is available as an npm package:

npm install @yext/api

To call the Entities: Get endpoint, do something like the following:

import {KnowledgeGraphApi} from '@yext/api';
...
  const kg = new KnowledgeGraphApi({apiKey: 'YOUR_API_KEY'});
  const entity = await kg.getEntity('ENTITY_ID');

Deno

This package can be used on Deno via the esm.sh CDN.

import {KnowledgeGraphApi} from 'https://esm.sh/@yext/api';
const kg = new KnowledgeGraphApi({apiKey: 'YOUR_API_KEY'});
const entity = await kg.getEntity('ENTITY_ID');