View Source Data Imports

A Data Import represents a time CharityAPI.org retrieved and imported the latest data from the IRS.

Get Data Import By ID

Retrieve a dataimport by its ID.

HTTP Request

GET https://api.charityapi.org/api/dataimports/:id

curl 

curl "https://api.charityapi.org/api/dataimports/:id" \
  -H "apikey: apikeyhere"

Responses:

Success 

{
    "data": {
        "completed": true,
        "crawled_urls": [
            "https://www.irs.gov/pub/irs-soi/eo1.csv",
            "https://www.irs.gov/pub/irs-soi/eo2.csv",
            "https://www.irs.gov/pub/irs-soi/eo3.csv",
            "https://www.irs.gov/pub/irs-soi/eo4.csv"
        ],
        "id": 355,
        "inserted_at": "2022-09-19T00:00:00",
        "name": "Data Import 2022-09-19",
        "s3_path": "redacted",
        "s3_urls": "redacted",
        "to_crawl_urls": [
            "https://www.irs.gov/pub/irs-soi/eo1.csv",
            "https://www.irs.gov/pub/irs-soi/eo2.csv",
            "https://www.irs.gov/pub/irs-soi/eo3.csv",
            "https://www.irs.gov/pub/irs-soi/eo4.csv"
        ],
        "updated_at": "2022-09-19T02:16:04"
    }
}

Data Import In Progress

If a dataimport is currently in progress, it will show "completed": false. 

{
    "data": {
        "completed": false,
        "crawled_urls": [
            "https://www.irs.gov/pub/irs-soi/eo1.csv",
            "https://www.irs.gov/pub/irs-soi/eo2.csv"
        ],
        "id": 600,
        "inserted_at": "2023-09-19T00:00:00",
        "name": "Data Import 2023-09-19",
        "s3_path": "redacted",
        "s3_urls": "redacted",
        "to_crawl_urls": [
            "https://www.irs.gov/pub/irs-soi/eo1.csv",
            "https://www.irs.gov/pub/irs-soi/eo2.csv",
            "https://www.irs.gov/pub/irs-soi/eo3.csv",
            "https://www.irs.gov/pub/irs-soi/eo4.csv"
        ],
        "updated_at": "2023-09-19T02:16:04"
    }
}

No Results 

{
    "data": null
}

Get Recent Data Imports

You can also retrieve the most recent dataimports by providing the string "recent" instead of a dataimport ID. This will return an object with 3 keys:

KeyDescriptionNotes
in_progress_dataimportThe data import currently in progress, if anynull if none in progress
most_recent_complete_dataimportThe most recent data import that's completeN/A
most_recent_dataimportThe most recent data import regardless of statusN/A

The same data import may appear in multiple keys; for example if it is both the most recent and complete data import.

HTTP Request

GET https://api.charityapi.org/api/dataimports/recent

curl 

curl "https://api.charityapi.org/api/dataimports/recent" \
  -H "apikey: apikeyhere"

Returns a list of dataimports.

Responses: 

{
    "data": {
        "in_progress_dataimport": null,
        "most_recent_complete_dataimport": {
            "completed": true,
            "crawled_urls": [
                "https://www.irs.gov/pub/irs-soi/eo1.csv",
                "https://www.irs.gov/pub/irs-soi/eo2.csv",
                "https://www.irs.gov/pub/irs-soi/eo3.csv",
                "https://www.irs.gov/pub/irs-soi/eo4.csv"
            ],
            "id": 357,
            "inserted_at": "2022-10-17T04:00:00",
            "name": "Data Import 2022-10-17",
            "s3_path": "redacted",
            "s3_urls": "redacted",
            "to_crawl_urls": [
                "https://www.irs.gov/pub/irs-soi/eo1.csv",
                "https://www.irs.gov/pub/irs-soi/eo2.csv",
                "https://www.irs.gov/pub/irs-soi/eo3.csv",
                "https://www.irs.gov/pub/irs-soi/eo4.csv"
            ],
            "updated_at": "2022-10-17T07:51:42"
        },
        "most_recent_dataimport": {
            "completed": true,
            "crawled_urls": [
                "https://www.irs.gov/pub/irs-soi/eo1.csv",
                "https://www.irs.gov/pub/irs-soi/eo2.csv",
                "https://www.irs.gov/pub/irs-soi/eo3.csv",
                "https://www.irs.gov/pub/irs-soi/eo4.csv"
            ],
            "id": 357,
            "inserted_at": "2022-10-17T04:00:00",
            "name": "Data Import 2022-10-17",
            "s3_path": "redacted",
            "s3_urls": "redacted",
            "to_crawl_urls": [
                "https://www.irs.gov/pub/irs-soi/eo1.csv",
                "https://www.irs.gov/pub/irs-soi/eo2.csv",
                "https://www.irs.gov/pub/irs-soi/eo3.csv",
                "https://www.irs.gov/pub/irs-soi/eo4.csv"
            ],
            "updated_at": "2022-10-17T07:51:42"
        }
    }
}