{ "info": { "author": "BigDataCloud", "author_email": "support@bigdatacloud.net", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "# BigDataCloud Python API Client\n\n\nA Python client for connecting to the API services provided by [BigDataCloud](https://www.bigdatacloud.net)\n\n\n## What API services does [BigDataCloud](https://www.bigdatacloud.net) offer?\n\nBigDataCloud offers a range of extremely useful and fast APIs that can be utilised in both backend and frontend scenarios.\nFrom validating customer input live to the next generation of IP Geolocation technology, BigDataCloud has an API suitable to your needs.\n\nFor a full list of APIs, visit our [documentation area](https://www.bigdatacloud.net/ip-geolocation-apis).\n\nYou can access any and all BigDataCloud APIs with a free API Key.\nTo get your API Key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.net/customer/account).\nIf you are not yet a customer, it is completely free to join.\n\n\n\n## Documentation\n\nFor documentation specific to this api client, please read below.\nFor more specific documentation to the APIs available, including endpoints, request and response data, please visit our [documentation area](https://www.bigdatacloud.net/ip-geolocation-apis).\n\n\n\n## Authentication / Identification\n\nTo use this API client you must have a BigDataCloud API Key.\nTo get your personal key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.net/customer/account).\nIf you are not yet a customer, it is completely free to join.\n\nSimply provide this key when initiating the api client, and it will be included in all requests to the BigDataCloud API Server.\nSee the example below.\n\n\n\n## Python 2.x Installation\n\n`pip install bigdatacloudapi-client`\n\n\n## Python 3.x Installation\n\n`pip3 install bigdatacloudapi-client`\n\n\n\n## Example usage\n\n```python\nimport bigdatacloudapi\n\napiKey = 'XXX' # XXX being your api key found at: https://www.bigdatacloud.net/customer/account\n\nclient = bigdatacloudapi.Client(apiKey)\n\nresultObject,httpResponseCode = client.getIpGeolocationFull({\"ip\":\"8.8.8.8\"})\n\nprint('HTTP Response Code: ',httpResponseCode)\nprint('Lookup IP: ',resultObject['ip'])\nprint('Result: ',resultObject)\n```\n\n\n## Example output\n\n```python\n{\n \"ip\": \"8.8.8.8\",\n \"country\": {\n \"isoAlpha2\": \"US\",\n \"isoAlpha3\": \"USA\",\n \"m49Code\": 840,\n \"isoName\": \"United States of America (the)\",\n \"isoAdminLanguages\": [\n {\n \"isoAlpha3\": \"eng\",\n \"isoAlpha2\": \"en\",\n \"isoName\": \"English\"\n }\n ],\n \"unRegion\": \"Americas/Northern America\",\n \"currency\": {\n \"numericCode\": 840,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"minorUnits\": 2\n },\n \"wbRegion\": {\n \"id\": \"NAC\",\n \"iso2Code\": \"XU\",\n \"value\": \"North America\"\n },\n \"wbIncomeLevel\": {\n \"id\": \"HIC\",\n \"iso2Code\": \"XD\",\n \"value\": \"High income\"\n },\n \"callingCode\": \"1\",\n \"countryFlagEmoji\": \"\u00f0\u0178\u2021\u00ba\u00f0\u0178\u2021\u00b8\"\n },\n \"location\": {\n \"isoPrincipalSubdivision\": \"California\",\n \"isoPrincipalSubdivisionCode\": \"US-CA\",\n \"city\": \"Mountain View\",\n \"postcode\": \"94043\",\n \"latitude\": 37.42,\n \"longitude\": -122.09,\n \"timeZone\": {\n \"ianaTimeId\": \"America/Los_Angeles\",\n \"displayName\": \"(UTC-08:00) Pacific Time (US & Canada)\",\n \"effectiveTimeZoneFull\": \"Pacific Daylight Time\",\n \"effectiveTimeZoneShort\": \"PDT\",\n \"UtcOffsetSeconds\": -25200,\n \"UtcOffset\": \"-07\",\n \"isDaylightSavingTime\": true,\n \"localTime\": \"2019-04-06T04:06:39.1691744\"\n }\n },\n \"lastUpdated\": \"2019-04-06T09:09:36.1877959Z\",\n \"network\": {\n \"registry\": \"ARIN\",\n \"registryStatus\": \"assigned\",\n \"registeredCountry\": \"US\",\n \"registeredCountryName\": \"United States of America (the)\",\n \"organisation\": \"Google LLC\",\n \"isReachableGlobally\": true,\n \"isBogon\": false,\n \"bgpPrefix\": \"8.8.8.0/24\",\n \"bgpPrefixNetworkAddress\": \"8.8.8.0\",\n \"bgpPrefixLastAddress\": \"8.8.8.255\",\n \"totalAddresses\": 256,\n \"carriers\": [\n {\n \"asn\": \"AS15169\",\n \"asnNumeric\": 15169,\n \"organisation\": \"Google LLC\",\n \"name\": \"GOOGLE\",\n \"registry\": \"ARIN\",\n \"registeredCountry\": \"US\",\n \"registeredCountryName\": \"United States of America (the)\",\n \"registrationDate\": \"2000-03-30\",\n \"registrationLastChange\": \"2012-02-25\",\n \"totalIpv4Addresses\": 8698103,\n \"totalIpv4Prefixes\": 435,\n \"totalIpv4BogonPrefixes\": 0,\n \"rank\": 53,\n \"rankText\": \"#53 out of 62,872\"\n }\n ],\n \"viaCarriers\": [\n {\n \"asn\": \"AS7018\",\n \"asnNumeric\": 7018,\n \"organisation\": \"ATT Services Inc.\",\n \"registeredCountry\": \"US\",\n \"registeredCountryName\": \"United States of America (the)\",\n \"rank\": 2\n },\n /*........*/\n {\n \"asn\": \"AS31019\",\n \"asnNumeric\": 31019,\n \"organisation\": \"Paulus M. Hoogsteder trading as Meanie\",\n \"registeredCountry\": \"NL\",\n \"registeredCountryName\": \"Netherlands (the)\",\n \"rank\": 51153\n }\n ]\n },\n \"confidence\": \"low\",\n \"confidenceArea\": [\n {\n \"latitude\": 18.0256672,\n \"longitude\": -66.5275345\n },\n /*........*/\n {\n \"latitude\": 18.0256672,\n \"longitude\": -66.5275345\n }\n ],\n \"securityThreat\": \"unknown\",\n \"hazardReport\": {\n \"isKnownAsTorServer\": false,\n \"isKnownAsProxy\": false,\n \"isKnownAsMailServer\": false,\n \"isKnownAsPublicRouter\": false,\n \"isBogon\": false,\n \"isUnreachable\": false\n }\n}\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bigdatacloudapi/python-api-client", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "bigdatacloudapi-client", "package_url": "https://pypi.org/project/bigdatacloudapi-client/", "platform": "", "project_url": "https://pypi.org/project/bigdatacloudapi-client/", "project_urls": { "Homepage": "https://github.com/bigdatacloudapi/python-api-client" }, "release_url": "https://pypi.org/project/bigdatacloudapi-client/1.0.1/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "A Python client for BigDataCloud API connectivity (https://www.bigdatacloud.net)", "version": "1.0.1" }, "last_serial": 5111553, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "671a45487d41996bb6ee0319d8ee1dbe", "sha256": "eb3c9fb04da5ab246b7e434e232cca3b6b12a6e63dbe6c4028c894e999646abd" }, "downloads": -1, "filename": "bigdatacloudapi_client-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "671a45487d41996bb6ee0319d8ee1dbe", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5011, "upload_time": "2019-04-08T02:05:49", "url": "https://files.pythonhosted.org/packages/7a/04/5431b299b0a168652857bc3d305202c7701e1a3eb4dab5eb07017557a339/bigdatacloudapi_client-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1336fc5ffec0021fc62f8d4a9886a933", "sha256": "f6967f3b31335c66527106a998eb96b7002d36ef316254926bfe999827a1eb57" }, "downloads": -1, "filename": "bigdatacloudapi-client-1.0.0.tar.gz", "has_sig": false, "md5_digest": "1336fc5ffec0021fc62f8d4a9886a933", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4390, "upload_time": "2019-04-08T02:05:52", "url": "https://files.pythonhosted.org/packages/aa/f6/15b96e5c93869740a81107409ca0ef588a6c9f6bf2762671cb6328a94358/bigdatacloudapi-client-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "7114672e5e6fc20ad40cc1bd8a1dbcf1", "sha256": "d45a26c5c6e6e867274a74e5317738533571b391a394dece82fd91cdcf5d9754" }, "downloads": -1, "filename": "bigdatacloudapi_client-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7114672e5e6fc20ad40cc1bd8a1dbcf1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5004, "upload_time": "2019-04-08T02:08:45", "url": "https://files.pythonhosted.org/packages/31/1f/58b2cb63eb87c079ec5c5e58dff3ae29dadd1636818c40ab811c2acddfea/bigdatacloudapi_client-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "952bb530276cf2e344e7e7541b054cc2", "sha256": "3c2189f7f658a942f7338c58f2709f117f24522c2f493125820723294af48bbd" }, "downloads": -1, "filename": "bigdatacloudapi-client-1.0.1.tar.gz", "has_sig": false, "md5_digest": "952bb530276cf2e344e7e7541b054cc2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4371, "upload_time": "2019-04-08T02:08:46", "url": "https://files.pythonhosted.org/packages/70/1d/de9612756b9e1572c6c697b8f7a2f79975df9d2eea0417d3e4192711418d/bigdatacloudapi-client-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7114672e5e6fc20ad40cc1bd8a1dbcf1", "sha256": "d45a26c5c6e6e867274a74e5317738533571b391a394dece82fd91cdcf5d9754" }, "downloads": -1, "filename": "bigdatacloudapi_client-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7114672e5e6fc20ad40cc1bd8a1dbcf1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5004, "upload_time": "2019-04-08T02:08:45", "url": "https://files.pythonhosted.org/packages/31/1f/58b2cb63eb87c079ec5c5e58dff3ae29dadd1636818c40ab811c2acddfea/bigdatacloudapi_client-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "952bb530276cf2e344e7e7541b054cc2", "sha256": "3c2189f7f658a942f7338c58f2709f117f24522c2f493125820723294af48bbd" }, "downloads": -1, "filename": "bigdatacloudapi-client-1.0.1.tar.gz", "has_sig": false, "md5_digest": "952bb530276cf2e344e7e7541b054cc2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4371, "upload_time": "2019-04-08T02:08:46", "url": "https://files.pythonhosted.org/packages/70/1d/de9612756b9e1572c6c697b8f7a2f79975df9d2eea0417d3e4192711418d/bigdatacloudapi-client-1.0.1.tar.gz" } ] }