# mozscape-request

> Nodejs client for Mozscape API

Latest version **0.0.4** (published 2015-09-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install mozscape-request
pnpm add mozscape-request
yarn add mozscape-request
bun add mozscape-request
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2015-09-05 |
| First published | 2015-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Bambou |
| Maintainers | ybonnefond |
| Keywords | moz, moz.com, mozscape, seo, moz api, mozscape api |

## Links

- npm: https://www.npmjs.com/package/mozscape-request
- Repository: https://github.com/ybonnefond/node-mozscape
- Homepage: https://github.com/optimizme/node-moz
- Issues: http://github.com/ybonnefond/node-mozscape/issues
- npm.io page: https://npm.io/package/mozscape-request

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.60.0

## Recent versions

- 0.0.4 (latest) — 2015-09-05
- 0.0.2 — 2015-09-04
- 0.0.1 — 2015-09-04

## README

## Moz

- [Get a moz authentication token and secret](https://moz.com/products/api/keys)
- [Moz api documentation](https://moz.com/help/guides/moz-api/mozscape)

## installation

```bash
  npm install mozscape-request
```

## Documentation
- [API documentation](docs/api.md)
- [Flags](docs/flags.md)

## Basic Usage

### Require the module and pass your options
```javascript
  var moz = require('node-moz')({
    accessId: '<YOUR ACCESSID>',
    secret: '<YOUR SECRET>',
    expires: 300  // Optional, default set to 300
  });
```

Available options:
- **accessId** {string} : Mozscape access id
- **secret** {string} : Mozscape secret
- **url** {string} [optional] : Api url, Default: http://apiv2.ahrefs.com/,
- **expires** {boolean} [optional] : Expires delay, Default: 300

### Build and run a query

```javascript
  var query = moz.newQuery('url-metrics')
    .target('http://moz.com')
    .cols(['canonical_url', 'external_links', 'root_domains_linking', 'moz_rank_url'])
    .sort('page_authority')
    .limit(10)

  moz.send(query, function(err, result){

    var canonical_url         = result.uu;
    var external_links        = result.ued;
    var root_domains_linking  = result.uipl;
    var moz_rank_url          = result.umrp;

  });
```

Result contains the response of the mozscape API. Check the [documentation of each endpoint](https://moz.com/help/guides/moz-api/mozscape/api-reference) to get the key corresponding to the parameter you have passed.

### Batch mode

To use the batch mode, simply pass an array to the `targets` method. Batch mode request use POST method.

Note: Batch mode is currently working only on the url-metrics endpoint

```javascript
  var query = moz.newQuery('url-metrics')
    .target(['http://moz.com', 'http://optimiz.me'])
    .cols(['canonical_url', 'external_links', 'root_domains_linking', 'moz_rank_url'])
    .sort('page_authority')
    .limit(10)

  moz.send(query, function(err, result){

  });
```

### Metadata

Metadata request are done in a similar fashion:

```javascript

  moz.metadata('last_update', function(err, last_update){

  });

  // Which is the short for:

  var query = moz.newQuery('metadata')
    .target('last_update');

  moz.send(query, function(err, result){

  });
```

### Flags
Use the bitsToFlags method to translate a bitflags sum to an array of flags:

```javascript
  var query = moz.newQuery('links')
    .target('http://moz.com'])
    .linkCols(['Flags'])
    .sort('page_authority')
    .limit(10)

  moz.send(query, function(err, result){
    // result.if return the bitflags sum for the flag linkCols parameters
    var flags = moz.bitsToFlags(result.if);
    // flags: ['no_follow', 'img', '301_redirect']
  });
```

## Run tests

You must specify your token to run the test suite:

```bash
  ACCESSID="<ACCESSID>" SECRET="<SECRET>" npm test
```

You can also run the tests agains your own target if needed (default is `moz.com`):
```bash
  TARGET=<YOUR TARGET> ACCESSID="<ACCESSID>" SECRET="<SECRET>" npm test
```

## Generate API documentation

```bash
  npm run-script doc
```

## Todo:
- Support request frequency rate


## Special Thanks
Developed for <a target="_blank" href="http://optimiz.me">Optimiz.me</a>, an online software designed to help working the SEO optimisation of your web site, by yourself, without the need of technical knowledge.

Développé pour <a target="_blank" href="http://optimiz.me">Optimiz.me</a> un logiciel en ligne conçu pour aider à travailler l'optimisation du référencement de votre site web, par vous-même, sans besoin de connaissances techniques.

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