{"id":23663451,"url":"https://github.com/eyolas/node-jcdecaux","last_synced_at":"2025-12-06T09:30:22.410Z","repository":{"id":17248852,"uuid":"20018167","full_name":"eyolas/node-jcdecaux","owner":"eyolas","description":"nodejs client for JCDecaux Open Data","archived":false,"fork":false,"pushed_at":"2022-12-27T09:25:08.000Z","size":599,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-24T16:19:36.873Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eyolas.png","metadata":{"files":{"readme":"README.md","changelog":"history.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-21T11:02:04.000Z","updated_at":"2023-03-10T08:05:07.000Z","dependencies_parsed_at":"2023-01-13T19:14:10.539Z","dependency_job_id":null,"html_url":"https://github.com/eyolas/node-jcdecaux","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyolas%2Fnode-jcdecaux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyolas%2Fnode-jcdecaux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyolas%2Fnode-jcdecaux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyolas%2Fnode-jcdecaux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eyolas","download_url":"https://codeload.github.com/eyolas/node-jcdecaux/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239662734,"owners_count":19676435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-29T05:28:22.737Z","updated_at":"2025-12-06T09:30:22.087Z","avatar_url":"https://github.com/eyolas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status][build-image]][build-url]\n[![NPM version][npm-image]][npm-url]\n[![Dependency Status][gemnasium-image]][gemnasium-url]\n\n## nodejs client for JCDecaux Open Data\n\nThis project is a client libray for JC Decaux Open Data. In order to use this API, you need to get a key at http://developer.jcdecaux.com.\n\n## Installation\n\n```\n$ npm install node-jcdecaux\n```\n\n## historic:\nsee [historic](history.md)\n\n## Usage\n\n```js\nvar JCDecaux = require('node-jcdecaux').JCDecaux;\nvar Api = new JCDecaux(APIKEY)\n```\n\n/!\\ for old nodejs or for browser, include a promise polyfill ([promise-polyfill][promise-polyfill-url], [yaku][yaku-url]) or [es6-shim][es6-shim-url]\n\n## Features\n\nAll method return promise.\n\n### constructor(apiKey, options)\n\nThe first parameter is required. All others are optional\n\n* `apiKey` - api key (for get a key go http://developer.jcdecaux.com) - Required\n* `options` - options :\n  - `contractName` - set the default contract for all method - Optional\n  - `urlApi` - url of JCDecaux api (default: `https://api.jcdecaux.com/vls/v1/`) - Optional\n  - `timeout` - Integer containing the number of milliseconds to wait for a request to respond before aborting the request\n\n### getContracts()\n\nGet the contract list\n\n### getStation(stationId, contractName)\n\nGet station information\n\n* `stationId` - id of the station - Required\n* `contractName` - contract name - Optional if set on init\n\n### getStations()\n\nGet the station list\n\n### getStationsByContract(contractName)\n\nGet the stations of a contract\n\n* `contractName` - contract name - Optional if set on init\n\n## Example\n\n```js\nvar JCDecaux = require('node-jcdecaux').JCDecaux;\nvar apiKey = 'your api key';\n\nvar Api = new JCDecaux(apiKey);\n\nApi.getContracts().then(function(result) {\n  console.log(result);\n});\n\n```\n\n## Run tests\n\n```Shell\nAPIKEY=yourapikey npm test\n```\n\n## Authors\n\n  - [David Touzet](https://github.com/eyolas)\n\n# License\n\n  MIT\n\n[build-image]: https://travis-ci.org/eyolas/node-jcdecaux.svg?branch=master\n[build-url]: https://travis-ci.org/eyolas/node-jcdecaux\n[npm-image]: https://img.shields.io/npm/v/node-jcdecaux.svg?style=flat-square\n[npm-url]: https://github.com/eyolas/node-jcdecaux\n[gemnasium-image]: http://img.shields.io/gemnasium/eyolas/node-jcdecaux.svg?style=flat-square\n[gemnasium-url]: https://gemnasium.com/eyolas/node-jcdecaux\n[promise-polyfill-url]:https://github.com/taylorhakes/promise-polyfill\n[yaku-url]:https://github.com/ysmood/yaku\n[es6-shim-url]:https://github.com/paulmillr/es6-shim\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyolas%2Fnode-jcdecaux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feyolas%2Fnode-jcdecaux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyolas%2Fnode-jcdecaux/lists"}