apiverve-historicalevents


Nameapiverve-historicalevents JSON
Version 1.1.4 PyPI version JSON
download
home_pageNone
SummaryHistorical Events is a simple tool for getting historical events. It returns a list of historical events between 300BC and 2012
upload_time2024-08-20 20:28:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseNone
keywords historical events history historical events api history api historical events data
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Historical Events API
============

Historical Events is a simple tool for getting historical events. It returns a list of historical events between 300BC and 2012

![Build Status](https://img.shields.io/badge/build-passing-green)
![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
![Prod Ready](https://img.shields.io/badge/production-ready-blue)

This is a Python API Wrapper for the [Historical Events API](https://apiverve.com/marketplace/api/historicalevents)

---

## Installation
	pip install apiverve-historicalevents

---

## Configuration

Before using the historicalevents API client, you have to setup your account and obtain your API Key.  
You can get it by signing up at [https://apiverve.com](https://apiverve.com)

---

## Usage

The Historical Events API documentation is found here: [https://docs.apiverve.com/api/historicalevents](https://docs.apiverve.com/api/historicalevents).  
You can find parameters, example responses, and status codes documented here.

### Setup

```
# Import the client module
from apiverve_historicalevents.apiClient import HistoricaleventsAPIClient

# Initialize the client with your APIVerve API key
api = HistoricaleventsAPIClient("[YOUR_API_KEY]")
```

---


### Perform Request
Using the API client, you can perform requests to the API.

###### Define Query

```
query = { "text": "moon landing" }
```

###### Simple Request

```
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
```

###### Example Response

```
{
  "status": "ok",
  "error": null,
  "data": {
    "count": 6,
    "filteredOn": [
      "text"
    ],
    "events": [
      {
        "year": "1969",
        "month": "05",
        "day": "18",
        "date": "1969/05/18",
        "event": " Apollo program: ''Apollo 10'' (Tom Stafford, Gene Cernan, John Young) is launched, on the full dress-rehearsal for the Moon landing.",
        "range": "May",
        "granularity": "year"
      },
      {
        "year": "1969",
        "month": "05",
        "day": "25",
        "date": "1969/05/25",
        "event": "Apollo program: ''Apollo 10'' returns to Earth, after a successful 8-day test of all the components needed for the upcoming first manned Moon landing.",
        "range": "May",
        "granularity": "year"
      },
      {
        "year": "1969",
        "month": "07",
        "day": "20",
        "date": "1969/07/20",
        "event": " Apollo program: The lunar module ''Eagle'' lands on the lunar surface. An estimated 500 million people worldwide watch in awe as Neil Armstrong takes his historic first steps on the Moon at 02:56 UTC, the largest television audience for a live broadcast at that time.cite web|title=Manned Space Chronology: Apollo_11|url=<a href=\"http://www.spaceline.org/flightchron/apollo11.html|publisher=spaceline.org|accessdate=2008-02-06|\">http://www.spaceline.org/flightchron/apollo11.html|publisher=spaceline.org|accessdate=2008-02-06|</a> archiveurl= <a href=\"http://web.archive.org/web/20080214213826/http://www.spaceline.org/flightchron/apollo11.html|\">http://web.archive.org/web/20080214213826/http://www.spaceline.org/flightchron/apollo11.html|</a> archivedate= 14 February 2008 !--DASHBot--| deadurl= no}}cite web|title= Apollo Anniversary: Moon Landing quotInspired Worldquot|url=<a href=\"http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|publisher=nationalgeographic.com|accessdate=2008-02-06|\">http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|publisher=nationalgeographic.com|accessdate=2008-02-06|</a> archiveurl= <a href=\"http://web.archive.org/web/20080209140059/http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|\">http://web.archive.org/web/20080209140059/http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|</a> archivedate= 9 February 2008 !--DASHBot--| deadurl= no}}",
        "range": "July",
        "granularity": "year"
      },
      {
        "year": "1969",
        "month": "07",
        "day": "20",
        "date": "1969/07/20",
        "event": "The ''Apollo 11'' astronauts return from the first successful Moon landing, and are placed in biological isolation for several days, on the chance they may have brought back lunar germs. The airless lunar environment is later determined to preclude microscopic life.",
        "range": "July",
        "granularity": "year"
      },
      {
        "year": "1971",
        "month": "02",
        "day": "08",
        "date": "1971/02/08",
        "event": "Apollo program: ''Apollo 14'' returns to Earth after the third manned Moon landing.",
        "range": "February",
        "granularity": "year"
      },
      {
        "year": "1973",
        "month": "01",
        "day": "07",
        "date": "1973/01/07",
        "event": "Elvis Presley's concert in Hawaii. The first worldwide telecast by an entertainer watched by more people than watched the Apollo moon landings.",
        "range": "January",
        "granularity": "year"
      }
    ]
  },
  "code": 200
}
```

---

## Customer Support

Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).

---

## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.

---

## Legal

All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.

---

## License
Licensed under the The MIT License (MIT)

Copyright (&copy;) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "apiverve-historicalevents",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "historical events, history, historical events api, history api, historical events data",
    "author": null,
    "author_email": "APIVerve <hello@apiverve.com>",
    "download_url": "https://files.pythonhosted.org/packages/63/83/c18d52900501be29f002571fa02cb4c0b0e30aa359b821a16c7d575b72b9/apiverve_historicalevents-1.1.4.tar.gz",
    "platform": null,
    "description": "Historical Events API\r\n============\r\n\r\nHistorical Events is a simple tool for getting historical events. It returns a list of historical events between 300BC and 2012\r\n\r\n![Build Status](https://img.shields.io/badge/build-passing-green)\r\n![Code Climate](https://img.shields.io/badge/maintainability-B-purple)\r\n![Prod Ready](https://img.shields.io/badge/production-ready-blue)\r\n\r\nThis is a Python API Wrapper for the [Historical Events API](https://apiverve.com/marketplace/api/historicalevents)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-historicalevents\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the historicalevents API client, you have to setup your account and obtain your API Key.  \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Historical Events API documentation is found here: [https://docs.apiverve.com/api/historicalevents](https://docs.apiverve.com/api/historicalevents).  \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_historicalevents.apiClient import HistoricaleventsAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = HistoricaleventsAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"text\": \"moon landing\" }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n  \"status\": \"ok\",\r\n  \"error\": null,\r\n  \"data\": {\r\n    \"count\": 6,\r\n    \"filteredOn\": [\r\n      \"text\"\r\n    ],\r\n    \"events\": [\r\n      {\r\n        \"year\": \"1969\",\r\n        \"month\": \"05\",\r\n        \"day\": \"18\",\r\n        \"date\": \"1969/05/18\",\r\n        \"event\": \" Apollo program: ''Apollo 10'' (Tom Stafford, Gene Cernan, John Young) is launched, on the full dress-rehearsal for the Moon landing.\",\r\n        \"range\": \"May\",\r\n        \"granularity\": \"year\"\r\n      },\r\n      {\r\n        \"year\": \"1969\",\r\n        \"month\": \"05\",\r\n        \"day\": \"25\",\r\n        \"date\": \"1969/05/25\",\r\n        \"event\": \"Apollo program: ''Apollo 10'' returns to Earth, after a successful 8-day test of all the components needed for the upcoming first manned Moon landing.\",\r\n        \"range\": \"May\",\r\n        \"granularity\": \"year\"\r\n      },\r\n      {\r\n        \"year\": \"1969\",\r\n        \"month\": \"07\",\r\n        \"day\": \"20\",\r\n        \"date\": \"1969/07/20\",\r\n        \"event\": \" Apollo program: The lunar module ''Eagle'' lands on the lunar surface. An estimated 500 million people worldwide watch in awe as Neil Armstrong takes his historic first steps on the Moon at 02:56 UTC, the largest television audience for a live broadcast at that time.cite web|title=Manned Space Chronology: Apollo_11|url=<a href=\\\"http://www.spaceline.org/flightchron/apollo11.html|publisher=spaceline.org|accessdate=2008-02-06|\\\">http://www.spaceline.org/flightchron/apollo11.html|publisher=spaceline.org|accessdate=2008-02-06|</a> archiveurl= <a href=\\\"http://web.archive.org/web/20080214213826/http://www.spaceline.org/flightchron/apollo11.html|\\\">http://web.archive.org/web/20080214213826/http://www.spaceline.org/flightchron/apollo11.html|</a> archivedate= 14 February 2008 !--DASHBot--| deadurl= no}}cite web|title= Apollo Anniversary: Moon Landing quotInspired Worldquot|url=<a href=\\\"http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|publisher=nationalgeographic.com|accessdate=2008-02-06|\\\">http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|publisher=nationalgeographic.com|accessdate=2008-02-06|</a> archiveurl= <a href=\\\"http://web.archive.org/web/20080209140059/http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|\\\">http://web.archive.org/web/20080209140059/http://news.nationalgeographic.com/news/2004/07/0714_040714_moonlanding.html|</a> archivedate= 9 February 2008 !--DASHBot--| deadurl= no}}\",\r\n        \"range\": \"July\",\r\n        \"granularity\": \"year\"\r\n      },\r\n      {\r\n        \"year\": \"1969\",\r\n        \"month\": \"07\",\r\n        \"day\": \"20\",\r\n        \"date\": \"1969/07/20\",\r\n        \"event\": \"The ''Apollo 11'' astronauts return from the first successful Moon landing, and are placed in biological isolation for several days, on the chance they may have brought back lunar germs. The airless lunar environment is later determined to preclude microscopic life.\",\r\n        \"range\": \"July\",\r\n        \"granularity\": \"year\"\r\n      },\r\n      {\r\n        \"year\": \"1971\",\r\n        \"month\": \"02\",\r\n        \"day\": \"08\",\r\n        \"date\": \"1971/02/08\",\r\n        \"event\": \"Apollo program: ''Apollo 14'' returns to Earth after the third manned Moon landing.\",\r\n        \"range\": \"February\",\r\n        \"granularity\": \"year\"\r\n      },\r\n      {\r\n        \"year\": \"1973\",\r\n        \"month\": \"01\",\r\n        \"day\": \"07\",\r\n        \"date\": \"1973/01/07\",\r\n        \"event\": \"Elvis Presley's concert in Hawaii. The first worldwide telecast by an entertainer watched by more people than watched the Apollo moon landings.\",\r\n        \"range\": \"January\",\r\n        \"granularity\": \"year\"\r\n      }\r\n    ]\r\n  },\r\n  \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (&copy;) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Historical Events is a simple tool for getting historical events. It returns a list of historical events between 300BC and 2012",
    "version": "1.1.4",
    "project_urls": {
        "Documentation": "https://docs.apiverve.com/api/historicalevents?utm_source=pypi",
        "Homepage": "https://apiverve.com?utm_source=pypi",
        "Repository": "https://github.com/apiverve/historicalevents.Python-API",
        "Twitter": "https://twitter.com/apivervehq"
    },
    "split_keywords": [
        "historical events",
        " history",
        " historical events api",
        " history api",
        " historical events data"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e6c70df57e90ca66b32cae55c5edf9ff5b04a146bf74693f6bd8fbaf0e76b67",
                "md5": "cee550f7b0e5dd32899229f072fe6374",
                "sha256": "063afeebd6c81751474df37581479f96b9d9318205aa9c8ec7c2cba15a9b2ec7"
            },
            "downloads": -1,
            "filename": "apiverve_historicalevents-1.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cee550f7b0e5dd32899229f072fe6374",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 7666,
            "upload_time": "2024-08-20T20:28:49",
            "upload_time_iso_8601": "2024-08-20T20:28:49.785859Z",
            "url": "https://files.pythonhosted.org/packages/8e/6c/70df57e90ca66b32cae55c5edf9ff5b04a146bf74693f6bd8fbaf0e76b67/apiverve_historicalevents-1.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6383c18d52900501be29f002571fa02cb4c0b0e30aa359b821a16c7d575b72b9",
                "md5": "d2c5e08ae3c3d69d333263b6ecc65d77",
                "sha256": "ea267a8a55959adc9d2929db4592528531e9d2d526a3589eea7a0957279d965d"
            },
            "downloads": -1,
            "filename": "apiverve_historicalevents-1.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "d2c5e08ae3c3d69d333263b6ecc65d77",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 8716,
            "upload_time": "2024-08-20T20:28:52",
            "upload_time_iso_8601": "2024-08-20T20:28:52.401645Z",
            "url": "https://files.pythonhosted.org/packages/63/83/c18d52900501be29f002571fa02cb4c0b0e30aa359b821a16c7d575b72b9/apiverve_historicalevents-1.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-20 20:28:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "apiverve",
    "github_project": "historicalevents.Python-API",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "apiverve-historicalevents"
}
        
Elapsed time: 0.96071s