# 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.

[Yext APIs]: https://hitchhikers.yext.com/docs/

## 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:

[Entities: Get]: https://hitchhikers.yext.com/docs/knowledgeapis/knowledgegraph/entities/entities/#operation/getEntity

```TypeScript
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.

[Deno]: https://deno.land/
[esm.sh]: https://esm.sh/

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


Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6

@yext/api

afitz

afitzgeraldyext

alex_ginsberg

aliang_yext

bchin95

benmcginnis

bhaines-yext

canderson_yext

cblair_yext

christianterence

cjiang2000

cxchen

data-enabler

dwuyext

eal172

eercelebi

eleeyext

eseff

gweiler

hgaertner

hoosred

inemzer

jachen1997

jalloy

jameshu01

jaredhood

jbaik

jesuyed

johncho92

johnnguyen

joshuahsueh

jpjamipark

jrhoads

jronkin_yext

jtufts

kunal-p

lki9419

mancusi

maurinator

mbowman

mpittinsky

mwoon

mxs2019

nmanu

npark

npatel94

oshi

peteros

pshah28

rconsalo

rpope

sgresh_yext

sharvey

sjayakumar

ssaunders

stephenrva

sukim

svc_jenkins_consulting_yext

tbirdsall

tconnolly

telliottyext

tmeyer2115

tritpham

tterbush

ttimblin

vboreda

wenright-yext

willgorick

yext_eng_npm

ytruong

zgeier

eefi

rchhatre

apavlick

mdavish

mtusman

pmomesso

(Experimental) An ambiguous license classifier was found.

What is an ambiguous license classifier?

Ambiguous License Classifier

Source files are encoded using a non-standard text encoding.

What is bad text encoding?

Bad text encoding

Package version is not a valid semantic version (semver).

What is bad semver?

Bad semver

Package has dependencies with an invalid semantic version. This could be a sign of beta, low quality, or unmaintained dependencies.

What is bad dependency semver?

Bad dependency semver

Source files contain bidirectional unicode control characters. This could indicate a Trojan source supply chain attack. See: trojansource.codes for more information.

What are bidirectional unicode control characters?

Bidirectional unicode control characters

This package has multiple bin scripts with the same name. This can cause non-deterministic behavior when installing or could be a sign of a supply chain attack.

What is bin script confusion?

Bin script confusion

This Chrome extension includes a content script '{scriptFile}' that runs on websites matching '{matches}'.

What are Chrome extension content scripts?

Chrome Extension Content Script

This Chrome extension requests access to '{host}'.

What are Chrome extension host permissions?

Chrome Extension Host Permission

This Chrome extension uses the '{permission}' permission.

What are Chrome extension permissions?

Chrome Extension Permission

This Chrome extension requests broad access to websites with the pattern '{host}'.

What are Chrome extension wildcard host permissions?

Chrome Extension Wildcard Host Permission

Semantic versions published out of chronological order.

What is a chronological version anomaly?

Chronological version anomaly

Project maintainer's SSH key has been compromised.

What is a compromised SSH key?

Compromised SSH key

(Experimental) Copyleft license information was found.

What do I need to know about license files?

Copyleft License

Contains a Critical Common Vulnerability and Exposure (CVE).

What is a critical CVE?

Title

Critical CVE

Contains a high severity Common Vulnerability and Exposure (CVE).

What is a CVE?

High CVE

Uses debug, reflection and dynamic code execution features.

What is debug access?

Debug access

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

What is a deprecated package?

Deprecated

(Experimental) Contains a known deprecated SPDX license exception.

What is a deprecated SPDX exception?

Deprecated SPDX exception

(Experimental) License is deprecated which may have legal implications regarding the package's use.

What is a deprecated license?

Deprecated license

Package name is similar to other popular packages and may not be the package you want.

What is a typosquat?

Possible typosquat attack

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

What is dynamic require?

Dynamic require

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

What is an empty package?

Empty package

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

What is environment variable access?

Environment variable access

(Experimental) Something was found which is explicitly marked as unlicensed.

Explicitly Unlicensed Item

Package optionally loads a dependency which is not specified within any of the package.json dependency fields. It may inadvertently be importing dependencies specified by other packages.

What are extraneous dependencies?

Name

Extraneous dependency

Contains a dependency which resolves to a file. This can obfuscate analysis and serves no useful purpose.

What are file dependencies?

File dependency

Accesses the file system, and could potentially read sensitive data.

What is filesystem access?

Filesystem access

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

What are wildcard dependencies?

Wildcard dependency

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable and can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are git dependencies?

Git dependency

Contains a dependency which resolves to a GitHub URL. Dependencies fetched from GitHub specifiers are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are GitHub dependencies?

GitHub dependency

AI has identified unusual behaviors that may pose a security risk.

What is an AI-detected potential code anomaly?

AI-detected potential code anomaly

AI has identified this package as a potential typosquat of a more popular package. This suggests that the package may be intentionally mimicking another package's name, description, or other metadata.

What is AI-detected potential typosquatting?

AI-detected possible typosquat

AI has identified this package as malware. This is a strong signal that the package may be malicious.

What is AI-detected potential malware?

AI-detected potential malware

AI has determined that this package may contain potential security issues or vulnerabilities.

What are AI-detected potential security risks?

AI-detected potential security risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Why is native code a concern?

Native code

Contains high entropy strings. This could be a sign of encrypted data, leaked secrets or obfuscated code.

What are high entropy strings?

High entropy strings

Contains unicode homoglyphs which can be used in supply chain confusion attacks.

What are unicode homoglyphs?

Unicode homoglyphs

Contains a dependency which resolves to a remote HTTP URL which could be used to inject untrusted code and reduce overall package reliability.

What are http dependencies?

HTTP dependency

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

What is an install script?

Install scripts

Package has an invalid manifest file and can cause installation problems if you try to use it.

@yext/api

TypeScript Client for Yext APIs

Quick Start

Node.js and npm

Deno

Related posts

Toptal’s GitHub Organization Hijacked: 10 Malicious Packages Published

Surveillance Malware Hidden in npm and PyPI Packages Targets Developers with Keyloggers, Webcam Capture, and Credential Theft