npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datacommonsorg/client

v0.0.1-alpha9

Published

JavaScript client for fetching Data Commons data as CSV, JSON, or GeoJSON.

Downloads

58

Readme

Data Commons JavaScript Client

JavaScript client for fetching Data Commons data as CSV, JSON, or GeoJSON.

References

Usage

Install @datacommonsorg/client

npm i @datacommonsorg/client

Initialize client

import { DataCommonsClient } from "@datacommonsorg/client";

const client = new DataCommonsClient();

Getting data

@datacommons/client fetches Data Commons statistical variable observations about an entity.

Data Commons tracks over 175k+ statistical variables, ranging from things like "Total Population" to "Total Number of Education Majors". An "entity" is usally a geographic place like The United States or California. A "variable observation" is the value of a variable for a particular entity (place) at a particular time. For example, the total population of California in 2021 was 39237836 (according to census.gov)

Variables and entities are identified by Data Commons Identifiers, or DCIDs.

To find the DCID of a entity or variable:

  1. Browse all 175K+ variables with the Data Commons Statistical Variable Explorer.
  2. Search for entities and variables with the Data Commons Search page.
  3. Use the Data Commons Graph Browser to understand the relationship between entities.

Data Requests

@datacommonsorg/client's DataCommonsClient request parameters:

| Parameter | Type | Description | | ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | entities | string[] | Entity DCIDs. Required if parentEntity and childType are empty. Example: ["country/USA", "country/IND"] | | parentEntity | string | Parent entity DCID. Required if entities is empty. | | childType | string | Child entity type. Required if entities is empty. Example: "State" | | date? | string | [optional] Only return observations from this date. Example: "2023" | | entityProps? | string[] | [optional] Fetch these entity properties from the knowledge graph. Default: ["name", "isoCode"] | | variableProps? | string[] | [optional] Fetch these variable properties from the knowledge graph. Default: ["name"] | | perCapitaVariables? | string[] | [optional] Performs per-capita caluclation for all of these variables Must be a subset of variables param. | | geoJsonProperty? | string | [optional] [getGeoJSON only] GeoJSON property name in the knowledge graph. Inferred if not provided. | | rewind? | boolean | [optional] [getGeoJSON only] If true, returns "rewound" geometries that are opposite of the right-hand rule. Default: true. | | fieldDelimiter? | string | [optional] Delimiter for column header fields. Example, if fieldDelimiter = ".", entity value header will be "entity.value". Default: __. |

For example, to fetch the median household income for all states in the US:

{
  parentEntity: "country/USA",
  childType: "State",
  variables: ["Median_Income_Household"],
};

Or, for all counties in the US:

{
  parentEntity: "country/USA",
  childType: "County",
  variables: ["Median_Income_Household"],
};

Fetch the number of business majors per-capita in (California, New York, Texas):

{
  entities: ["geoId/06", "geoId/36", "geoId/48"],
  variables: ["Count_Person_BachelorOfBusinessMajor"],
  perCapitaVariables: ["Count_Person_BachelorOfBusinessMajor"]
};

@datacommonsorg/client can fetch data as CSV, JSON, or GeoJSON.

DataCommonsClient data fetch methods

DataCommonsClient fetches either single data observations (getCsv, getDataRows, getGeoJson) or all data observations (getCsvSeries, getDataRowSeries) about a set of variables and places.

| Method | Output | Description | | ---------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | getCsv | string | CSV string with most recent data observations for the specified entities and variables | | getCsvSeries | string | CSV string with all data observations for the specified entities and variables | | getDataRows | Record<string, string \| number \| boolean \| null>[] | Data row objects with most recent data observations for the specified entities and variables | | getDataRowSeries | Record<string, string \| number \| boolean \| null>[] | Data row objects with all data observations for the specified entities and variables | | getGeoJson | Promise<FeatureCollection> | GeoJSON feature collection with place geometries and most recent data observations for the specified entities and variables |

Get CSV data (most recent observations)

Fetch total population below the poverty level for each US State

const response = await client.getCsv({
  variables: ["Count_Person_BelowPovertyLevelInThePast12Months"],
  parentEntity: "country/USA",
  childType: "State",
});
"Count_Person_BelowPovertyLevelInThePast12Months.date","Count_Person_BelowPovertyLevelInThePast12Months.name","Count_Person_BelowPovertyLevelInThePast12Months.unit","Count_Person_BelowPovertyLevelInThePast12Months.unitDisplayName","Count_Person_BelowPovertyLevelInThePast12Months.value","entity.isoCode","entity.name","entity.dcid"
"2021","Population Below Poverty Level Status in Past Year",null,null,769819,"US-AL","Alabama","geoId/01"
"2021","Population Below Poverty Level Status in Past Year",null,null,75016,"US-AK","Alaska","geoId/02"
"2021","Population Below Poverty Level Status in Past Year",null,null,934911,"US-AZ","Arizona","geoId/04"
"2021","Population Below Poverty Level Status in Past Year",null,null,468113,"US-AR","Arkansas","geoId/05"
"2021","Population Below Poverty Level Status in Past Year",null,null,4741175,"US-CA","California","geoId/06"
"2021","Population Below Poverty Level Status in Past Year",null,null,535976,"US-CO","Colorado","geoId/08"
"2021","Population Below Poverty Level Status in Past Year",null,null,351476,"US-CT","Connecticut","geoId/09"
"2021","Population Below Poverty Level Status in Past Year",null,null,109274,"US-DE","Delaware","geoId/10"
"2021","Population Below Poverty Level Status in Past Year",null,null,100618,"US-DC","District of Columbia","geoId/11"
"2021","Population Below Poverty Level Status in Past Year",null,null,2744612,"US-FL","Florida","geoId/12"
"2021","Population Below Poverty Level Status in Past Year",null,null,1441351,"US-GA","Georgia","geoId/13"
"2021","Population Below Poverty Level Status in Past Year",null,null,133740,"US-HI","Hawaii","geoId/15"
...

With per-capita calculation

const response = await client.getCsv({
  variables: ["Count_Person_BelowPovertyLevelInThePast12Months"],
  parentEntity: "country/USA",
  childType: "State",
  perCapitaVariables: ["Count_Person_BelowPovertyLevelInThePast12Months"],
});
"Count_Person_BelowPovertyLevelInThePast12Months.date","Count_Person_BelowPovertyLevelInThePast12Months.name","Count_Person_BelowPovertyLevelInThePast12Months.perCapita.date","Count_Person_BelowPovertyLevelInThePast12Months.perCapita.populationValue","Count_Person_BelowPovertyLevelInThePast12Months.perCapita.populationVariable","Count_Person_BelowPovertyLevelInThePast12Months.perCapita.value","Count_Person_BelowPovertyLevelInThePast12Months.unit","Count_Person_BelowPovertyLevelInThePast12Months.unitDisplayName","Count_Person_BelowPovertyLevelInThePast12Months.value","entity.isoCode","entity.name","entity.dcid"
"2021","Population Below Poverty Level Status in Past Year","2021",5039877,"Count_Person",0.15274559279918934,null,null,769819,"US-AL","Alabama","geoId/01"
"2021","Population Below Poverty Level Status in Past Year","2021",732673,"Count_Person",0.10238674006002678,null,null,75016,"US-AK","Alaska","geoId/02"
"2021","Population Below Poverty Level Status in Past Year","2021",7276316,"Count_Person",0.128486860658608,null,null,934911,"US-AZ","Arizona","geoId/04"
"2021","Population Below Poverty Level Status in Past Year","2021",3025891,"Count_Person",0.15470253224587402,null,null,468113,"US-AR","Arkansas","geoId/05"
"2021","Population Below Poverty Level Status in Past Year","2021",39237836,"Count_Person",0.12083171457263851,null,null,4741175,"US-CA","California","geoId/06"
"2021","Population Below Poverty Level Status in Past Year","2021",5812069,"Count_Person",0.09221776272786851,null,null,535976,"US-CO","Colorado","geoId/08"
"2021","Population Below Poverty Level Status in Past Year","2021",3605597,"Count_Person",0.09748066686321294,null,null,351476,"US-CT","Connecticut","geoId/09"
"2021","Population Below Poverty Level Status in Past Year","2021",1003384,"Count_Person",0.10890546391012812,null,null,109274,"US-DE","Delaware","geoId/10"
"2021","Population Below Poverty Level Status in Past Year","2021",670050,"Count_Person",0.1501649130661891,null,null,100618,"US-DC","District of Columbia","geoId/11"
"2021","Population Below Poverty Level Status in Past Year","2021",21781128,"Count_Person",0.12600871727120835,null,null,2744612,"US-FL","Florida","geoId/12"
"2021","Population Below Poverty Level Status in Past Year","2021",10799566,"Count_Person",0.13346378919301016,null,null,1441351,"US-GA","Georgia","geoId/13"
"2021","Population Below Poverty Level Status in Past Year","2021",1441553,"Count_Person",0.09277494479911595,null,null,133740,"US-HI","Hawaii","geoId/15"
...

Get CSV data (all observations)

Fetch combined criminal activity for California cities

const response = await client.getCsvSeries({
  variables: ["Count_CriminalActivities_CombinedCrime"],
  entities: [
    "geoId/0644000", // Los Angeles
    "geoId/0667000", // San Francisco
    "geoId/0664000", // Sacramento
    "geoId/0666000", // San Diego
    "geoId/0627000", // Fresno
    "geoId/0668000", // San Jose
    "geoId/0653000", // Oakland
  ],
  perCapitaVariables: ["Count_CriminalActivities_CombinedCrime"],
});
"entity__dcid","entity__isoCode","entity__name","perCapita__date","perCapita__populationValue","perCapita__populationVariable","perCapita__value","variable__date","variable__dcid","variable__name","variable__unit","variable__unitDisplayName","variable__value"
"geoId/0627000",null,"Fresno","2008",545567,"Count_Person",0.04593752921272731,"2008","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,25062
"geoId/0627000",null,"Fresno","2009",545567,"Count_Person",0.044207219278292124,"2009","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,24118
"geoId/0627000",null,"Fresno","2010",545567,"Count_Person",0.05066472128996072,"2010","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,27641
"geoId/0627000",null,"Fresno","2011",545567,"Count_Person",0.05218790725978661,"2011","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,28472
"geoId/0627000",null,"Fresno","2012",545567,"Count_Person",0.05245735170932259,"2012","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,28619
"geoId/0627000",null,"Fresno","2013",545567,"Count_Person",0.04641043171599455,"2013","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,25320
"geoId/0627000",null,"Fresno","2014",545567,"Count_Person",0.04351802803322048,"2014","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,23742
"geoId/0627000",null,"Fresno","2015",545567,"Count_Person",0.0453326539178506,"2015","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,24732
"geoId/0627000",null,"Fresno","2016",545567,"Count_Person",0.0439707680266585,"2016","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,23989
"geoId/0627000",null,"Fresno","2017",545567,"Count_Person",0.04291131978290476,"2017","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,23411
"geoId/0627000",null,"Fresno","2018",545567,"Count_Person",0.03849939604118284,"2018","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,21004
"geoId/0644000",null,"Los Angeles","2008",3822238,"Count_Person",0.03383907543172351,"2008","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,129341
"geoId/0644000",null,"Los Angeles","2009",3822238,"Count_Person",0.03136146937998105,"2009","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,119871
"geoId/0644000",null,"Los Angeles","2010",3822238,"Count_Person",0.029440605216106374,"2010","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,112529
"geoId/0644000",null,"Los Angeles","2011",3822238,"Count_Person",0.028190552236673907,"2011","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,107751
"geoId/0644000",null,"Los Angeles","2012",3822238,"Count_Person",0.028069157388943337,"2012","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,107287
"geoId/0644000",null,"Los Angeles","2013",3822238,"Count_Person",0.02715634138952101,"2013","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,103798
"geoId/0644000",null,"Los Angeles","2014",3822238,"Count_Person",0.027064510373242062,"2014","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,103447
"geoId/0644000",null,"Los Angeles","2015",3822238,"Count_Person",0.0313402776069936,"2015","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,119790
"geoId/0644000",null,"Los Angeles","2016",3822238,"Count_Person",0.03380454069055878,"2016","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,129209
"geoId/0644000",null,"Los Angeles","2017",3822238,"Count_Person",0.03493738485149277,"2017","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,133539
"geoId/0644000",null,"Los Angeles","2018",3822238,"Count_Person",0.03480866445260604,"2018","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,133047
"geoId/0644000",null,"Los Angeles","2019",3822238,"Count_Person",0.0331680026204543,"2019","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,126776
"geoId/0653000",null,"Oakland","2008",430553,"Count_Person",0.06896247384178023,"2008","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,29692
"geoId/0653000",null,"Oakland","2009",430553,"Count_Person",0.06314901998127989,"2009","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,27189
"geoId/0653000",null,"Oakland","2010",430553,"Count_Person",0.055173230705627414,"2010","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,23755
"geoId/0653000",null,"Oakland","2011",430553,"Count_Person",0.06432193016887584,"2011","Count_CriminalActivities_CombinedCrime","Criminal Activities",null,null,27694
...

Get Data Rows (JSON, most recent observations)

Get population per-capita below the poverty level for each US State

const response = await client.getDataRows({
  variables: ["Count_Person_BelowPovertyLevelInThePast12Months"],
  parentEntity: "country/USA",
  childType: "State",
  perCapitaVariables: ["Count_Person_BelowPovertyLevelInThePast12Months"],
});
[
  {
    "entity.dcid": "geoId/01",
    "entity.name": "Alabama",
    "entity.isoCode": "US-AL",
    "Count_Person_BelowPovertyLevelInThePast12Months.value": 769819,
    "Count_Person_BelowPovertyLevelInThePast12Months.date": "2021",
    "Count_Person_BelowPovertyLevelInThePast12Months.unit": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.unitDisplayName": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.name": "Population Below Poverty Level Status in Past Year"
  },
  {
    "entity.dcid": "geoId/02",
    "entity.name": "Alaska",
    "entity.isoCode": "US-AK",
    "Count_Person_BelowPovertyLevelInThePast12Months.value": 75016,
    "Count_Person_BelowPovertyLevelInThePast12Months.date": "2021",
    "Count_Person_BelowPovertyLevelInThePast12Months.unit": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.unitDisplayName": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.name": "Population Below Poverty Level Status in Past Year"
  },
  {
    "entity.dcid": "geoId/04",
    "entity.name": "Arizona",
    "entity.isoCode": "US-AZ",
    "Count_Person_BelowPovertyLevelInThePast12Months.value": 934911,
    "Count_Person_BelowPovertyLevelInThePast12Months.date": "2021",
    "Count_Person_BelowPovertyLevelInThePast12Months.unit": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.unitDisplayName": null,
    "Count_Person_BelowPovertyLevelInThePast12Months.name": "Population Below Poverty Level Status in Past Year"
  },
  ...
]

Get Data Rows (all observations)

Fetch combined criminal activity for California cities

const response = await client.getDataRowSeries({
  variables: ["Count_CriminalActivities_CombinedCrime"],
  entities: [
    "geoId/0644000", // Los Angeles
    "geoId/0667000", // San Francisco
    "geoId/0664000", // Sacramento
    "geoId/0666000", // San Diego
    "geoId/0627000", // Fresno
    "geoId/0668000", // San Jose
    "geoId/0653000", // Oakland
  ],
  perCapitaVariables: ["Count_CriminalActivities_CombinedCrime"],
});
[
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 25062,
    "variable__date": "2008",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.04593752921272731,
    "perCapita__date": "2008",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 24118,
    "variable__date": "2009",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.044207219278292124,
    "perCapita__date": "2009",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 27641,
    "variable__date": "2010",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.05066472128996072,
    "perCapita__date": "2010",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 28472,
    "variable__date": "2011",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.05218790725978661,
    "perCapita__date": "2011",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 28619,
    "variable__date": "2012",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.05245735170932259,
    "perCapita__date": "2012",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 25320,
    "variable__date": "2013",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.04641043171599455,
    "perCapita__date": "2013",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 23742,
    "variable__date": "2014",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.04351802803322048,
    "perCapita__date": "2014",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 24732,
    "variable__date": "2015",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.0453326539178506,
    "perCapita__date": "2015",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 23989,
    "variable__date": "2016",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.0439707680266585,
    "perCapita__date": "2016",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 23411,
    "variable__date": "2017",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.04291131978290476,
    "perCapita__date": "2017",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0627000",
    "entity__name": "Fresno",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 21004,
    "variable__date": "2018",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.03849939604118284,
    "perCapita__date": "2018",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 545567
  },
  {
    "entity__dcid": "geoId/0644000",
    "entity__name": "Los Angeles",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 129341,
    "variable__date": "2008",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.03383907543172351,
    "perCapita__date": "2008",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 3822238
  },
  {
    "entity__dcid": "geoId/0644000",
    "entity__name": "Los Angeles",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 119871,
    "variable__date": "2009",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.03136146937998105,
    "perCapita__date": "2009",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 3822238
  },
  {
    "entity__dcid": "geoId/0644000",
    "entity__name": "Los Angeles",
    "entity__isoCode": null,
    "variable__dcid": "Count_CriminalActivities_CombinedCrime",
    "variable__value": 112529,
    "variable__date": "2010",
    "variable__unit": null,
    "variable__unitDisplayName": null,
    "variable__name": "Criminal Activities",
    "perCapita__value": 0.029440605216106374,
    "perCapita__date": "2010",
    "perCapita__populationVariable": "Count_Person",
    "perCapita__populationValue": 3822238
  },
  ...
]

Get GeoJSON data (most recent observations)

Get GeoJSON for US States with population data

const response = await client.getGeoJSON({
  variables: ["Count_Person"],
  parentEntity: "country/USA",
  childType: "State",
});
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "entity.dcid": "geoId/01",
        "entity.name": "Alabama",
        "entity.isoCode": "US-AL",
        "Count_Person.value": 5074296,
        "Count_Person.date": "2022",
        "Count_Person.unit": null,
        "Count_Person.unitDisplayName": null,
        "Count_Person.name": "Total Population"
      },
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                -88.327302,
                30.229882
              ],
              ...
            ]
          ],
          ...
        ]
      }
    },
    ...
  ]
}

License

Apache 2.0

Support

For general questions or issues, please open an issue on our issues page. For all other questions, please send an email to [email protected].