https://github.com/jonthegeek/apisniffer

What the Package Does
https://github.com/jonthegeek/apisniffer

Last synced: 24 days ago
JSON representation

What the Package Does

• Host: GitHub
• URL: https://github.com/jonthegeek/apisniffer
• Owner: jonthegeek
• License: other
• Created: 2024-06-06T17:16:04.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-06-14T16:10:04.000Z (10 months ago)
• Last Synced: 2025-03-18T01:42:39.767Z (28 days ago)
• Language: R
• Homepage: https://jonthegeek.github.io/apisniffer/
• Size: 375 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• jimsghstars - jonthegeek/apisniffer - What the Package Does (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# apisniffer

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![CRAN status](https://www.r-pkg.org/badges/version/apisniffer)](https://CRAN.R-project.org/package=apisniffer)

[![Codecov test coverage](https://codecov.io/gh/jonthegeek/apisniffer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/apisniffer?branch=main)

[![R-CMD-check](https://github.com/jonthegeek/apisniffer/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/apisniffer/actions/workflows/R-CMD-check.yaml)

When you load a web page, it often calls APIs to populate the page with data. 

If you know what you're looking for, you can use Chrome Devtools to find these API calls.

This package aims to automate that process.

This package is extremely experimental.

The data returned by the main `sniff()` function will definitely change in upcoming versions (to be more useful and user-friendly).

You also can't currently interact with the page, which in a lot of cases means you can't actually trigger the API calls of interest.

But it's a start!

## Installation

::: .pkgdown-release

Install the released version of apisniffer from [CRAN](https://cran.r-project.org/):

```{r, eval = FALSE}

install.packages("apisniffer")

```

:::

::: .pkgdown-devel

Install the development version of apisniffer from [GitHub](https://github.com/):

```{r, eval = FALSE}

# install.packages("pak")

pak::pak("jonthegeek/apisniffer")

```

:::

## Usage

The single exported function is `sniff()`.

```{r eval = FALSE}

api_information <- sniff("https://proton.me/mail/pricing")

```

## Code of Conduct

Please note that the apisniffer project is released with a [Contributor Code of Conduct](https://jonthegeek.github.io/apisniffer/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.