{"id":23692456,"url":"https://github.com/yext/search-core","last_synced_at":"2026-01-07T20:14:31.568Z","repository":{"id":37079722,"uuid":"306365666","full_name":"yext/search-core","owner":"yext","description":"Javascript Networking Layer for the Answers API","archived":false,"fork":false,"pushed_at":"2024-12-10T19:25:55.000Z","size":2827,"stargazers_count":5,"open_issues_count":1,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-23T12:05:55.107Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-22T14:35:58.000Z","updated_at":"2024-12-10T17:52:57.000Z","dependencies_parsed_at":"2024-06-27T02:32:38.988Z","dependency_job_id":"66f5b95d-73ba-42aa-8ee3-190522504854","html_url":"https://github.com/yext/search-core","commit_stats":{"total_commits":212,"total_committers":23,"mean_commits":9.217391304347826,"dds":0.7547169811320755,"last_synced_commit":"2b6bfc45c646cadc81121f59c04a6303ee7218c2"},"previous_names":["yext/answers-core"],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yext","download_url":"https://codeload.github.com/yext/search-core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231810491,"owners_count":18429999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-30T03:27:57.008Z","updated_at":"2026-01-07T20:14:31.490Z","avatar_url":"https://github.com/yext.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Search Core\n\n\n\u003cdiv\u003e\n  \u003ca href=\"https://npmjs.org/package/@yext/search-core\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@yext/search-core\" alt=\"NPM version\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\" alt=\"License\"/\u003e\n  \u003c/a\u003e\n  \u003ca href='https://coveralls.io/github/yext/search-core?branch=master'\u003e\n    \u003cimg src='https://coveralls.io/repos/github/yext/search-core/badge.svg?branch=master' alt='Coverage Status' /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\nSearch Core is a networking library for interacting with the Yext Search API.\n\n[Full Documentation](./docs/search-core.md)\n\n## Features\n\n- Works in both the **browser** and **Node.js**\n- 100% **TypeScript**, with detailed request and response models\n- Compatible with both **CommonJS** and **ES6** imports\n- Offers a ponyfilled ES5 bundle which doesn't pollute the global namespace\n\n## Getting Started\n\nFor a full getting started walk through, view our [official Hitchhiker Guide](https://hitchhikers.yext.com/guides/search-core-getting-started/).\n\nFirst, install Search-core via [npm](https://www.npmjs.com/get-npm):\n\n```bash\nnpm install @yext/search-core\n```\n\nNext, import and initialize the core library in your application.\n\nThe apiKey and experienceKey will come from your Search experience on yext.com. You can signup for a free trial at [https://www.yext.com/free-trial/](https://www.yext.com/free-trial/).\n\n```js\nimport { provideCore } from '@yext/search-core';\n\nconst core = provideCore({\n  apiKey: '\u003cyour api key\u003e',\n  experienceKey: '\u003cone of your experience keys\u003e',\n  locale: 'en',\n  experienceVersion: 'PRODUCTION',\n});\n```\n\nTo use the library with Node, use the following import instead:\n```js\nconst { provideCore } = require('@yext/search-core');\n``` \n\nNow that the core is initialized, let's run a search on an \"FAQs\" vertical.\n\n```js\ncore.verticalSearch({\n  verticalKey: 'FAQs',\n  query: 'What is Yext Search?',\n}).then(results =\u003e {\n  // Do something with the search results\n}).catch(err =\u003e {\n  // Handle errors thrown by the core library\n});\n```\n\n### Explanation of Builds\n- The ESM (ES6) build will be used automatically by module bundlers that support it (e.g. Webpack). It can be specified directly by importing `@yext/search-core/lib/esm`\n- The CommonJS build will be used automatically by Node, but it can be specified directly by importing `@yext/search-core/lib/commonjs`\n- The Legacy (UMD) bundle should be used for supporting IE11 out of the box. It is compiled to ES5 and it contains the necessary ponyfills for IE11. If your application already contains polyfills, we recommend bundling one of the other builds in order to prevent your application from including duplicate polyfills. This bundle can be specified by importing `@yext/search-core/legacy`\n\n\nAnd that's it! See **[our documentation](./docs/search-core.searchcore.md)** for a full list of supported API calls.\n\n## License\n\nYext Search-core is an open-sourced library licensed under the [BSD-3 License](./LICENSE).\n\n## Third Party Licenses\n\nThe licenses of our 3rd party dependencies are collected here: [THIRD-PARTY-NOTICES](./THIRD-PARTY-NOTICES).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyext%2Fsearch-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyext%2Fsearch-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyext%2Fsearch-core/lists"}