# google-local-guides-api

> (Unofficial) Get your google contribution metadata using this api!

Latest version **1.0.6** (published 2020-05-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install google-local-guides-api
pnpm add google-local-guides-api
yarn add google-local-guides-api
bun add google-local-guides-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2020-05-22 |
| First published | 2020-05-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Jin |
| Maintainers | jinwookkim |
| Keywords | google contributions, google map contributions, google local guides, local guides, map contributions |

## Links

- npm: https://www.npmjs.com/package/google-local-guides-api
- Repository: https://github.com/BigIntJin/google-local-guides-api
- Homepage: https://github.com/BigIntJin/google-local-guides-api#readme
- Issues: https://github.com/BigIntJin/google-local-guides-api/issues
- npm.io page: https://npm.io/package/google-local-guides-api

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2020-05-22
- 1.0.5 — 2020-05-21
- 1.0.4 — 2020-05-21
- 1.0.3 — 2020-05-21
- 1.0.2 — 2020-05-21
- 1.0.1 — 2020-05-21
- 1.0.0 — 2020-05-21

## README

# (Unofficial) Google Local Guides API
This npm package will give you functionality to get your 
contribution metadata from your google local guides profile. 

This package will scrape the data on this modal for you:
![example google local guides metadata modal](images/Example%20Page.png)

_Note: there is no authentication when using this package because it'll scrape your public profile page,
which is accessible to everyone._

## Quickstart
Installation
```shell script
npm install google-local-guides-api
```

Usage
```javascript
const ContributionMetadata = require('google-local-guides-api');

let contributionMetadata = new ContributionMetadata();

async function () {
    // This initializes your link into the response body -- has to be in async/await func
    let link = "https://www.google.com/maps/contrib/0123456789";
    await contributionMetadata.init(link);

    // You can call get specific attributes like points
    let points = contributionMetadata.getPoints(); 
    
    // ...Or use getMetadata() to get all available attributes from you profile
    let metadata = contributionMetadata.getMetadata();
} 
```

What `link` are you talking about? How do I get my `link` variable?  

The `link` that you need is your publicly available local guides link found here:  
https://www.google.com/maps/contrib/  
 
When redirected to that link, the rest of the URL will populate with your google local guide ID and other information.   
You can just get the entire link and pass it in as the value as `link`.  
 
If you want to have a clean link, this is the structure that you can use:  
```
https://www.google.com/maps/contrib/0123456789  
``` 
The last path will be your numerical ID. 

_Note: within your redirected link, you might have a lot of other params attached to it. It's fine to pass the entire url. Honeybadger don't care._

## Endpoints
```javascript
const ContributionMetadata = require('google-local-guides-api');

let contributionMetadata = new ContributionMetadata();

// This initializes your link into the response body -- has to be in async/await func
async function () {
    await contributionMetadata.init(link);

    // You can call get specific attributes like points
    // These all return string type of a number associated with 
    // how many/how much for each attribute
    let points = contributionMetadata.getPoints(); 
    let level = contributionMetadata.getLevel();
    let reviews = contributionMetadata.getReviews();
    let ratings = contributionMetadata.getRatings();
    let questions = contributionMetadata.getQuestions();
    let placesAdded = contributionMetadata.getPlacesAdded();
    let edits = contributionMetadata.getEdits();
    let facts = contributionMetadata.getFacts();
    let videos = contributionMetadata.getVideos();
    let qa = contributionMetadata.getQA();
    let roadsAdded = contributionMetadata.getRoadsAdded();
    let listsPublished = contributionMetadata.getPublishedLists();
    
    // ...Or use getMetadata() to get all available attributes from you profile
    let metadata = contributionMetadata.getMetadata();
    // {
    //    points: string,
    //    level: string,
    //    reviews: string,
    //    ratings: string,
    //    questions: string,
    //    placesAdded: string,
    //    edits: string,
    //    facts: string,
    //    videos: string,
    //    qa: string,
    //    roadsAdded: string,
    //    listsPublished: string
    // }
} 
```

---
_Source: https://npm.io/package/google-local-guides-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._