https://github.com/metonym/fooddata-central

Node.js client and API types for USDA FoodData Central
https://github.com/metonym/fooddata-central

fooddata-central usda

Last synced: about 1 month ago
JSON representation

Node.js client and API types for USDA FoodData Central

• Host: GitHub
• URL: https://github.com/metonym/fooddata-central
• Owner: metonym
• License: mit
• Created: 2020-03-28T19:22:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-29T14:33:32.000Z (over 4 years ago)
• Last Synced: 2024-10-03T18:01:14.595Z (about 2 months ago)
• Topics: fooddata-central, usda
• Language: TypeScript
• Size: 14.6 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fooddata-central

[![NPM][npm]][npm-url]

[![Build][build]][build-badge]

> Node.js client and API types for [USDA FoodData Central](https://fdc.nal.usda.gov/).

FoodData Central is an API provided by the [U.S. Department of Agriculture](https://www.usda.gov/) that provides expanded nutrient profile data for foods.

## Getting Started

```bash

yarn add fooddata-central

```

## Prerequisites

An [API key](https://fdc.nal.usda.gov/api-key-signup.html) is required to interact with the FoodData Central API.

## Usage

```js

import Client from "fooddata-central";

(async () => {

  // initialize a new client

  const client = new Client({ api_key: "API_KEY" });

  // search foods based on an input

  const results = await client.search({ generalSearchInput: "raw broccoli" });

  if (results.success) {

    // get details for food item

    const details = await client.details(results.data.foods[0].fdcId);

    if (details.success) {

      console.log(details.data);

    }

  }

})();

```

### API

#### Search foods

Search the food database using the `search` method.

```ts

client.search({

  generalSearchInput?: string;

  includeDataTypeList?: string | string[];

  ingredients?: string;

  brandOwner?: string;

  requireAllWords?: boolean;

  pageNumber?: number;

  sortField?: "lowercaseDescription.keyword" | "dataType.keyword" | "publishedDate" | "fdcId";

  sortDirection?: "asc" | "desc";

})

```

#### Retrieve food details

Each food object returned from the `search` endpoint contains a unique `fdcId`.

Pass the `fdcId` value to the `details` method to retrieve the nutrient profile of the item.

```ts

client.details(fdcId: number)

```

## License

[MIT](LICENSE)

[npm]: https://img.shields.io/npm/v/fooddata-central.svg?color=blue

[npm-url]: https://npmjs.com/package/fooddata-central

[build]: https://travis-ci.com/metonym/fooddata-central.svg?branch=master

[build-badge]: https://travis-ci.com/metonym/fooddata-central