{"id":26120485,"url":"https://github.com/projectbabbler/ebird","last_synced_at":"2025-04-13T11:33:33.419Z","repository":{"id":48034839,"uuid":"51808847","full_name":"ProjectBabbler/ebird","owner":"ProjectBabbler","description":"Ebird scrapper api","archived":false,"fork":false,"pushed_at":"2022-12-07T17:45:01.000Z","size":235,"stargazers_count":4,"open_issues_count":8,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-02T00:13:27.879Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProjectBabbler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-16T04:51:17.000Z","updated_at":"2020-06-29T04:49:30.000Z","dependencies_parsed_at":"2023-01-24T19:33:58.796Z","dependency_job_id":null,"html_url":"https://github.com/ProjectBabbler/ebird","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectBabbler%2Febird","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectBabbler%2Febird/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectBabbler%2Febird/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectBabbler%2Febird/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProjectBabbler","download_url":"https://codeload.github.com/ProjectBabbler/ebird/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242856009,"owners_count":20196360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-03-10T13:15:08.654Z","updated_at":"2025-03-10T13:15:09.231Z","avatar_url":"https://github.com/ProjectBabbler.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ebird\n\nThis package is an api to ebird data.  It uses web scrapers to pull data from the ebird site.\n\n## Installation\n\n```\n    npm install ebird\n```\n\n## Usage\n\n```javascript\nvar ebird = require('ebird');\n\n// Create a new instance of the ebird api.\nvar instance = new ebird();\n\n// Authorize with an ebird username and password\ninstance.auth(username, password).then(() =\u003e {\n    // Once authorized, query for regions or another metric.  \n    instance.regions().then(results =\u003e {\n        console.log('Regions', JSON.stringify(results));\n    });\n\n    // Request countries in paralle with regions.\n    instance.countries().then(results =\u003e {\n        console.log('Counties', JSON.stringify(results));\n    });\n});\n```\n\n## API\n\n### constructor `ebird(opt_sessionToken)`\nConstructs an instance of the ebird api.  `var instance = new ebird();`  If you have a ebird session token you can pass that in the constructor `var instance = new ebird(sessionToken);`.\n\n### `auth(username, password) returns sessionToken`\nAuthenticates an ebird instance.  Returns a session token so you can skip full auth when using a different ebird instance.  Ebird uses phantom js to log in, which can be flaky.  To receive better reliability save the session token between uses to avoid instantiating phantom js.\n\n### totals\n### `totals.regions()` `totals.countries()` `totals.states()` `totals.counties()`\nThis functions all work the same.  They return a personal list of counts for a user for the given location.\n\n```javascript\n{\n    \"name\": place_name,\n    \"code\": ebird_code,\n    \"items\":[\n        {\n            \"number\": count,\n            \"time\": time_frame_string,\n        }\n        ...\n    ]\n```\n\n### lists\n### `list(ebird_code, time_frame_string, opt_year)`\nRetrieves an array of objects for a bird list.\n\n```javascript\n// Example response. ebird.list('US-CA', 'life');\n[\n    {\n        commonName: \"Black-bellied Whistling-Duck\",\n        date: \"24 Apr 2015\",\n        location: \"Baytown Nature Center (UTC 039)\",\n        rowNumber: \"1\",\n        scientificName: \"Dendrocygna autumnalis\",\n        sp: \"US-TX\",\n        speciesCode: \"bbwduc\",\n    },\n    ...\n]\n```\n\n\n### alerts\n### `alerts.needs(code)` `alerts.rarities(code)`\nReturns an array of sightings for either a needs or a rarities list.\n\n```javascript\n{\n    species: {\n        name: 'Pin-tailed Whydah ',\n        scientificName: 'Vidua macroura'\n    },\n    confirmed: true,\n    count: '1',\n    date: 'Apr 2, 2016 08:40',\n    location: {\n        name: 'Peck Rd. Water Conservation Park ',\n        lat: '34.10053',\n        long: '-118.01333'\n    },\n    checklist: 'http://ebird.org/ebird/view/checklist?subID=SUB_ID',\n    county: 'Los Angeles',\n    state: 'California, United States',\n    observer: 'eBirder User',\n    details: '',\n}\n```\n\n### targets\n### `targest.species(options)`\nReturns an array of species and frequencies for a user's target birds\n#### Options\n```javascript\nlocation: Location Code.\nstartMonth: Month number 1-12.\nendMonth: Month number 1-12.\nlocationFilter: Location code, 'aba', or 'world'.\ntimeFilter: 'life', 'year', 'month', or 'day'.\n```\n#### Results\n```javascript\n{\n    species: {\n        name: 'Yellow Warbler',\n        code: 'yelwar'\n    },\n    frequency: 5.77985,\n    map: 'http://ebird.org/...',\n}\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectbabbler%2Febird","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectbabbler%2Febird","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectbabbler%2Febird/lists"}