Narcissistic Preening Monarch
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    node-jppublic

    node-jp Build Status

    Client library of the statics data provided by the goverment of Japan.

    How to install

    npm install node-jp
    

    How to use

    You can use client's 3 APIs.

    • list: Get statistics table list
    • meta: Get statistics table meta information
    • search: Get statictics table data

    Before use these API, you need appId for configure client from this page. With this appId, you make client like below.

    var nodeJP = require('node-jp');
    
    var config = {
        appId : <Your application id from beyond site>
    };	
    
    var client = new nodeJP(config);
    

    And then you can get various data with this client.

    # Statistics List

    Get statistics table list. All API need callback function made by you. For example,

    function yourCallback(err, data) {
        // Write your code
        // data is different respective API 
    }
    
    client.list(params, yourCallback);
    

    Request

    Parameters which should be set are written in this manual

    Parameter key A use Example
    lang Response default language E or J
    surveyYears When target data is surveyed. Format is yyyy or yyyymm or yyyymm-yyyymm 2013
    openYears When target data is opened. Format is yyyy or yyyymm or yyyymm-yyyymm 2013
    statsField The field of target statistics data. 2-digit or 4-digit number which is based on category of statistics of Japan 02
    statsCode Goverment statistics code. 5-digit or 8-digit number 12345
    searchWord Your search keyword. Any string Tokyo
    searchKind Kind of target data 1: statistics data(default), 2: regional mesh, 3: social or population
    statsNameList Statistics survey name Y

    Response

    Response object is StatsList object. This object is composed of below members.

    Member A use Type
    result Response code and Error message Object
    parameter Your request parameters Object
    number Number of response list String
    list Statistics table list Array

    # Statistics Meta information

    Get meta information of statistics table. This API needs also your callback.

    Request

    In this API, you need to give only statsDataId. This ID is obtained from above list API.

    Parameter key A use Example
    statsDataId Statistics table id 0003003333

    Response

    Response object is MetaInfo object. This object is composed of below members.

    Member A use Type
    result Response code and Error message Object
    parameter Your request parameters Object
    tableInf Statistics table meta information Object
    classInf Factors of which statistics table is composed Object

    # Statistics Data

    Get statistics data. This API needs also your callback.

    Request

    Parameter key A use Example
    statsDataId Statistics table id 0003003333
    lvTab Table tag level. Format is X or X-X or -X or X- 1-9
    cdTab Item code 01000
    cdTabFrom Start item code of range search 01000
    cdTabTo End item code of range search 02000
    lvTime Time level. Format is the same as category level 1-9
    cdTime Item code about time 01000
    cdTimeFrom Start item code of range search 01000
    cdTimeTo End item code of range search 02000
    lvArea Area level. Format is the same as category level 1-9
    cdArea Item code about area 01000
    cdAreaFrom Start item code of range search 01000
    cdAreaTo End item code of range search 02000
    lvCat0[1-15] Category level. Format is the same as category level 1-9
    cdCat0[1-15] Item code about category 01000
    cdCat0[1-15]From Start item code of range search 01000
    cdCat0[1-15]To End item code of range search 02000
    ・・・ ・・・ ・・・
    startPosition Start offset of data list 1
    limit Max number of data list 15
    metaGetFlg Whether meta info is added or not Y or N
    cntGetFlg Only count of data list Y or N

    Response

    Client returns your callback StatsData object.

    Member A use Type
    result Response code and Error message Object
    parameter Your request parameters Object
    tableInf Statistics table meta information Object
    classInf Data of which statistics table is composed Object

    Data Source

    Gateway to Advanced and User-friendly statics service

    Keywords

    none

    install

    npm i node-jp

    Downloadsweekly downloads

    6

    version

    0.0.2

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar