ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The easiest way to query any data on Splitgraph is via the "Data Delivery Network" (DDN). The DDN is a single endpoint that speaks the PostgreSQL wire protocol. Any Splitgraph user can connect to it at data.splitgraph.com:5432 and query any version of over 40,000 datasets that are hosted or proxied by Splitgraph.

For example, you can query the personal_income_tax_filers_summary_dataset_1_major table in this repository, by referencing it like:

"ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest"."personal_income_tax_filers_summary_dataset_1_major"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "federal_amount_of_ny_adjusted_gross_income", -- Amount of federal‐source NYAGI (New York Adjusted Gross Income).  May be negative. For Full‐Year Nonresident and Part‐Year resident returns, this amount includes both non‐New York income and New York‐ source income; the amount computed in column one on the form IT‐203, page 2. For Full‐Year Resident returns, the Federal and NYS Amounts of New York Adjusted Gross Income are equal.
    "tax_liability", -- Amount of NYS tax liability.  May be negative due to refundable credits. The tax liability reflects the tax due (Tax Before Credits plus other NYS taxes), after nonrefundable and refundable credits. Negative values represent a refund. For Full‐Year Nonresident and Part‐Year Resident returns, this amount reflects NYS tax after allocation based on the ratio of New York‐source to federal‐source NYAGI.
    "sort_on_place", -- Sort Order on Place of Residence
    "place_of_residence", -- Name of the New York State County, State or Country of Residence Includes:  “Other Places‐ NYS Resident” means Full‐Yr. Resident returns that could not be classified by county.  “Other Places‐ Nonresident” means Full‐Yr. Nonresident unclassified returns, or with NY addresses; includes APO/FPO.  “All Othr Countries” means Countries outside the USA, other than those reported that year.  “All Places” combines all Places of Residence.
    "county", -- Name of New York State County  Same as the “Place of Residence” field, except for Full‐ Year Nonresidents, which includes: o “All” for all counties of other states in USA o “Not Applicable” for countries outside USA
    "country", -- Name of Country  “All” for all countries in “All Places”
    "number_of_returns", -- The number of returns filed. Note: Married filing joint returns count as one.
    "number_filing_single", -- The number of returns filed with Filing Status “Single”
    "number_filing_married_separate_or_widow_widower", -- The number of returns with Filing Status “Married Separate” or “Widow/Widower”
    "new_york_state_amount_of_ny_adjusted_gross_income", -- Amount of New York‐source NYAGI (New York Adjusted Gross Income). May be negative. The amount of federal adjusted gross income earned or received during the income year after certain modifications and before the subtraction of either the standard or itemized deductions, and dependent exemptions. For Full‐Year Nonresident and Part‐Year resident returns, the amount computed in column two on the form IT‐203, page 2. For Full‐Year Resident returns, the Federal and NYS Amounts of New York Adjusted Gross Income are equal.
    "sort_on_statuses", -- Sort Order on Tax Liability Status and NYS Residency Status
    "nys_residency_status", -- Status of NYS Residency: Full‐Year Resident, Full‐Year Nonresident, Part‐Year Resident, or All Filers.  Full‐Year Resident is a resident of New York State for the entire tax year.  Full‐Year Nonresident is a not a resident for the entire year.  Part‐Year Resident changes from a resident to a nonresident, or from a nonresident to a resident, during the tax year.  All Filers combines the above three residency statuses.
    "state", -- Name of State
    "notes", -- “d/” ‐ Tax Law secrecy provisions prohibit the disclosure of the data; it means that the specific data blanked‐out in the following columns of that record have a value but could not be reported. The “Number of Returns” field determines whether or not the dollar‐amount of data can be disclosed in that row. See the Limitations section of the Overview on these notes: “1/” ‐ The data in two Filing Status fields for Full‐Year Nonresidents, except for Totals, is not reported. “2/” ‐ The data for Full‐Year Nonresidents and Part‐Year Residents on components of income, modifications, and deductions, except for Totals, is not reported. “3/” ‐ The data for Full‐Year Nonresidents and Part‐Year Residents in the highest three income ranges, except for Totals, is not reported. “4/” ‐ The data for modifications, except for Totals, is not reported.
    "number_filing_married_joint", -- The number of returns with Filing Status “Married Joint”
    "tax_year", -- Tax Year
    "number_filing_head_of_household", -- The number of returns with Filing Status “Head of Household”
    "tax_liability_status" -- Status of Tax Liability: Taxable, Non‐Taxable, or All Returns.  Taxable return has any amount of positive tax liability.  Non‐Taxable return has no or zero tax liability, or a negative tax liability resulting from refundable credits.  All Returns combines the Taxable and Non‐Taxable returns.
FROM
    "ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest"."personal_income_tax_filers_summary_dataset_1_major"
LIMIT 100;

Connecting to the DDN is easy. All you need is an existing SQL client that can connect to Postgres. As long as you have a SQL client ready, you'll be able to query ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.ny.gov. When you queryny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).

We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.

Query Your Local Engine

Install Splitgraph Locally
bash -c "$(curl -sL https://github.com/splitgraph/splitgraph/releases/latest/download/install.sh)"
 

Read the installation docs.

Splitgraph Cloud is built around Splitgraph Core (GitHub), which includes a local Splitgraph Engine packaged as a Docker image. Splitgraph Cloud is basically a scaled-up version of that local Engine. When you query the Data Delivery Network or the REST API, we mount the relevant datasets in an Engine on our servers and execute your query on it.

It's possible to run this engine locally. You'll need a Mac, Windows or Linux system to install sgr, and a Docker installation to run the engine. You don't need to know how to actually use Docker; sgrcan manage the image, container and volume for you.

There are a few ways to ingest data into the local engine.

For external repositories (like this repository), the Splitgraph Engine can "mount" upstream data sources by using sgr mount. This feature is built around Postgres Foreign Data Wrappers (FDW). You can write custom "mount handlers" for any upstream data source. For an example, we blogged about making a custom mount handler for HackerNews stories.

For hosted datasets, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.

Mounting Data

This repository is an external repository. It's not hosted by Splitgraph. It is hosted by data.ny.gov, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.

First, install Splitgraph if you haven't already.

Mount the table with sgr mount

sgr mount socrata \
  "ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv" \
  --handler-options '{
    "domain": "data.ny.gov",
    "tables": {
        "personal_income_tax_filers_summary_dataset_1_major": "73iw-kuxv"
    }
}'

That's it! Now you can query the data in the mounted table like any other Postgres table.

Query the data with your existing tools

Once you've loaded the data into your local Splitgraph engine, you can query it with any of your existing tools. As far as they're concerned, ny-gov/personal-income-tax-filers-summary-dataset-1-major-73iw-kuxv is just another Postgres schema.