{"id":46843344,"url":"https://github.com/alercebroker/alerce_client","last_synced_at":"2026-03-10T14:02:13.084Z","repository":{"id":51513074,"uuid":"206174625","full_name":"alercebroker/alerce_client","owner":"alercebroker","description":"🐍 ALeRCE Python Client","archived":false,"fork":false,"pushed_at":"2026-03-04T18:14:44.000Z","size":445,"stargazers_count":9,"open_issues_count":20,"forks_count":1,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-03-05T00:42:24.666Z","etag":null,"topics":["alerce","astronomy","lsst","python","ztf"],"latest_commit_sha":null,"homepage":"https://alerce.readthedocs.io/en/latest/index.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alercebroker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-09-03T21:22:03.000Z","updated_at":"2026-03-04T18:17:49.000Z","dependencies_parsed_at":"2023-11-24T18:31:19.176Z","dependency_job_id":"941ef05b-a8e3-46e2-8d85-10bda13b6501","html_url":"https://github.com/alercebroker/alerce_client","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/alercebroker/alerce_client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alercebroker%2Falerce_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alercebroker%2Falerce_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alercebroker%2Falerce_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alercebroker%2Falerce_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alercebroker","download_url":"https://codeload.github.com/alercebroker/alerce_client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alercebroker%2Falerce_client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30336064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T12:41:07.687Z","status":"ssl_error","status_checked_at":"2026-03-10T12:41:06.728Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerce","astronomy","lsst","python","ztf"],"created_at":"2026-03-10T14:02:12.151Z","updated_at":"2026-03-10T14:02:13.076Z","avatar_url":"https://github.com/alercebroker.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![image](https://github.com/alercebroker/alerce_client/workflows/Tests/badge.svg)[![codecov](https://codecov.io/gh/alercebroker/alerce_client/graph/badge.svg?token=Y2AQJ3SWFE)](https://codecov.io/gh/alercebroker/alerce_client)![image](https://readthedocs.org/projects/alerce/badge/?version=latest)\n\n# ALeRCE Python Client\n\nALeRCE client is a Python library to interact with ALeRCE services and databases.\n\nThis README highlights installation, quickstart usage and migration notes for the\nmulti-survey client (ZTF and LSST). For the full reference and tutorials, see the official documentation at\nhttps://alerce.readthedocs.io/en/latest/\n\n## Key features\n\n- Multi-survey support: query ZTF and LSST data through a unified client.\n- Access to objects, lightcurves (detections / non-detections / forced photometry),\n  stamps, classifiers, crossmatches (catsHTM) and more.\n- Return formats: `json` (default), `pandas`, and `votable` where applicable.\n\n## Installing\n\nInstall from PyPI:\n\n```bash\npip install alerce\n```\n\nOr install from source:\n\n```bash\ngit clone https://github.com/alercebroker/alerce_client.git\ncd alerce_client\npython setup.py install\n```\n\n## Quickstart\n\nBasic usage with the `Alerce` client:\n\n```python\nfrom alerce.core import Alerce\nclient = Alerce()\n\n# Query objects (must specify survey for multi-survey API)\nztf_objects = client.query_objects(survey=\"ztf\", classifier=\"lc_classifier\", class_name=\"SN\", probability=0.8, format=\"pandas\")\n\n# Query a lightcurve (detections/non-detections/forced photometry)\nlightcurve = client.query_lightcurve(oid=\"ZTF18abbuksn\", survey=\"ztf\", format=\"json\")\n\n# Query detections only\ndetections = client.query_detections(oid=\"ZTF18abbuksn\", survey=\"ztf\", format=\"pandas\")\n\n# Get stamps for an object (first detection by default or use measurement_id)\nstamps = client.get_stamps(oid=\"ZTF18abkifng\", survey=\"ztf\")\n\n# Crossmatch (catsHTM conesearch)\nra, dec, radius = 10.0, 20.0, 1000  # radius in arcsec\ncone = client.catshtm_conesearch(ra, dec, radius, \"GAIA/DR1\", format=\"pandas\")\n```\n\nSee the documentation for many more examples and parameters.\n\n## Multi-survey notes / Migration from ZTF-only API\n\nThe client supports multiple surveys. Most query methods now require an explicit\n`survey` parameter. Supported surveys:\n\n- `ztf` — Zwicky Transient Facility\n- `lsst` — Legacy Survey of Space and Time (Rubin Observatory)\n\nBackward compatibility: many methods default to `survey=\"ztf\"` when omitted,\nbut this behavior is deprecated and will be removed in a future release. Update\nyour code to always pass `survey=\"ztf\"` or `survey=\"lsst\"` explicitly.\n\nObject ID formats differ between surveys:\n- ZTF: string IDs like `\"ZTF18abbuksn\"`\n- LSST: numeric-like IDs such as `45121627560013211`\n\n## Contributing\n\nPlease read `CONTRIBUTING.rst` for the project's contribution guidelines.\n\n## License\n\nThis project is licensed under the terms in `LICENSE.txt`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falercebroker%2Falerce_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falercebroker%2Falerce_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falercebroker%2Falerce_client/lists"}