https://github.com/emilhvitfeldt/walmartapi

Walmart Open API Wrapper
https://github.com/emilhvitfeldt/walmartapi

r rstats walmart-api

Last synced: 9 days ago
JSON representation

Walmart Open API Wrapper

• Host: GitHub
• URL: https://github.com/emilhvitfeldt/walmartapi
• Owner: EmilHvitfeldt
• License: other
• Created: 2017-12-09T05:02:50.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-19T18:26:39.000Z (over 4 years ago)
• Last Synced: 2024-10-28T17:32:49.356Z (11 days ago)
• Topics: r, rstats, walmart-api
• Language: R
• Size: 33.2 KB
• Stars: 18
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# walmartAPI

[![Travis build status](https://travis-ci.org/EmilHvitfeldt/walmartAPI.svg?branch=master)](https://travis-ci.org/EmilHvitfeldt/walmartAPI) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/walmartAPI)](https://cran.r-project.org/package=walmartAPI)

![downloads](http://cranlogs.r-pkg.org/badges/grand-total/walmartAPI)

The goal of **walmartAPI** is to give access to the API created by [walmartlabs](https://developer.walmartlabs.com/) to search products, locate stores etc etc.

To use this package you will need an API key which you can acquire by signing up on this website https://developer.walmartlabs.com/member.

## Installation

**walmartAPI** is available on CRAN and can be installed normally with 

```{r cran-installation, eval = FALSE}

install.packages("walmartAPI") #from CRAN 

``` 

or you can install **walmartAPI** from github with:

```{r gh-installation, eval = FALSE}

# install.packages("devtools")

devtools::install_github("EmilHvitfeldt/walmartAPI")

```

## Examples

This package provides a handful for functionalities. We are able to look up a specific product based on an ID.

```{r, eval=FALSE}

library(tidyverse)

library(walmartAPI)

key <- "************************"

walmartAPI::lookup(id = 19336123, key = key)

```

```{r, echo=FALSE, message=FALSE, warning=FALSE}

library(tidyverse)

library(walmartAPI)

walmartAPI::lookup(id = 19336123, key = "z2gz6g9jefqsjsye7fttakey")

```

search in products using plain text

```{r, eval=FALSE}

walmartAPI::searching("ipod", key = key)

```

```{r, echo=FALSE, message=FALSE, warning=FALSE}

walmartAPI::searching("ipod", key = "z2gz6g9jefqsjsye7fttakey")

```

and locate stores in your area

```{r, eval=FALSE}

store_locator(city = "Houston", key = key)

```

```{r, echo=FALSE, message=FALSE, warning=FALSE}

store_locator(city = "Houston", key = "z2gz6g9jefqsjsye7fttakey")

```