CARTO API

Carto Node API

Install

npm install

Run

• Development

npm run dev

• Production

npm run build

• Test

npm run test:build

npm run test:server

Open http://localhost:8081/tests/

Usage

JS

var Carto = require('carto-api-client');
var client = Carto.AuthenticatedClient.setConfig({
  baseUrl: 'foobar.com'
});

client.getUser()
  .then(console.log)
  .catch(console.error);

ES6

import Carto from 'carto-api-client';
const client = Carto.AuthenticatedClient.setConfig({
  baseUrl: 'foobar.com'
});

client.getUser()
  .then(console.log)
  .catch(console.error);

Browser

<script type="text/javascript" src="/carto-api-client/dist/carto-api-client.js"></script>

Browser Support

This library uses a fetch polyfill: whatwg-fetch

Documentation

Config

Visualization

client.getVisualization('myVizId', {} /* optional params */)
  .then(console.log)
  .catch(console.error);

Params

Filters

• with_id_or_name
• only_liked (default: true)
• only_shared (default: true)
• exclude_shared (default: true)
• exclude_raster (default: true)
• locked
• shared
• tags
• bbox
• privacy
• only_with_display_name (default: true)
• per_page
• page
• type
• types
• order

Options

• related
• load_related_canonical_visualizations
• show_user
• show_stats
• show_likes
• show_liked
• show_table
• show_permission
• show_synchronization
• show_uses_builder_features
• show_table_size_and_row_count
• password

Example:

client.getVisualization('myVizId', {
    privacy: 'PUBLIC',
    per_page: '3',
    show_stats: true,
    show_table_size_and_row_count: true
  })
  .then(console.log)
  .catch(console.error);