{"id":16039674,"url":"https://github.com/vacilando/gatsby-source-pocketapi","last_synced_at":"2026-05-19T07:36:47.362Z","repository":{"id":65728131,"uuid":"433996874","full_name":"Vacilando/gatsby-source-pocketapi","owner":"Vacilando","description":"GatsbyJS plugin fetching data from Pocket API","archived":false,"fork":false,"pushed_at":"2023-02-07T22:32:39.000Z","size":357,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-05T17:17:34.268Z","etag":null,"topics":["gatsbyjs","pocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Vacilando.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-12-01T21:53:12.000Z","updated_at":"2023-02-06T20:28:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"e9062ebe-0082-4712-b54c-46eced86a2dc","html_url":"https://github.com/Vacilando/gatsby-source-pocketapi","commit_stats":{"total_commits":44,"total_committers":6,"mean_commits":7.333333333333333,"dds":"0.43181818181818177","last_synced_commit":"53ae0ec6c636486d2495360aef0851ad0195b638"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Vacilando/gatsby-source-pocketapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vacilando%2Fgatsby-source-pocketapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vacilando%2Fgatsby-source-pocketapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vacilando%2Fgatsby-source-pocketapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vacilando%2Fgatsby-source-pocketapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vacilando","download_url":"https://codeload.github.com/Vacilando/gatsby-source-pocketapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vacilando%2Fgatsby-source-pocketapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274113797,"owners_count":25224481,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["gatsbyjs","pocket"],"created_at":"2024-10-08T23:06:39.176Z","updated_at":"2026-05-19T07:36:46.948Z","avatar_url":"https://github.com/Vacilando.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gatsby-source-pocketapi\n\nGatsbyJS plugin fetching data from Pocket API (a Mozilla project).\n\n## Compatibility\n\n- v4.x - for `Gatsby 4` and `Gatsby 5`\n\n## How to Use\n\n1.  `npm install --save gatsby-source-pocketapi`\n\n2.  Go to https://getpocket.com/developer/ and create a new app to get your consumer key.\n\n3.  Run `node node_modules/node-getpocket/authorise --consumerkey 'YOUR-CONSUMER-KEY'` and point your browser to http://127.0.0.1:8080 to get your `POCKET_ACCESS_TOKEN` string.\n\n    For more info on this process see https://github.com/vicchi/node-getpocket, which this plugin uses to talk to the Pocket API.\n\n4.  In your gatsby-config.js\n\n```javascript\nmodule.exports = {\n  plugins: [\n    {\n      resolve: `gatsby-source-pocketapi`,\n      options: {\n        consumerKey: INSERT_HERE_YOUR_POCKET_CONSUMER_KEY,\n        accessToken: INSERT_HERE_YOUR_POCKET_ACCESS_TOKEN,\n        weeksOfHistory: 52,\n        apiMaxRecordsToReturn: 10000,\n        getCurrentWeekOnly: `n`,\n        stateFilterString: 'archive',\n        tagFilter: false,\n        tagFilterString: '_untagged_',\n        favouriteFilter: false,\n        favouriteFilterValue: 0,\n        searchFilter: false,\n        searchFilterString: 'These 21 things',\n        domainFilter: false,\n        domainFilterString: 'buzzfeed.com',\n      },\n    },\n  ],\n};\n```\n\n## Plugin Options\n\n- **weeksOfHistory**: Number of weeks worth of articles to fetch\n- **apiMaxRecordsToReturn**: Number of records to return. If higher than 5000, the items will be fetched in several calls.\n- **getCurrentWeekOnly**:\n  - `n` will fetch data based on the settings above.\n  - `y` returns the current week and the last week (it'll make sense when you try it).\n- **stateFilterString**:\n  - `unread` = only return unread items.\n  - `archive` = only return archived items.\n  - `all` = return both unread and archived items.\n- **tagFilter**:\n  - `true` will use the `tagFilterString` value to get articles with that tag.\n  - `false` will ignore the `tagFilterString` value\n- **tagFilterString**: If `tagFilter` is true then get articles tagged with this value. `'\\_untagged\\_'` will only return articles with no tags.\n- **favouriteFilter** (note UK English spelling!):\n  - `true` will use the `favouriteFilterValue` to get articles that have/have not been favourited in Pocket\n  - `false` will ignore the `favouriteFilterValue`\n- **favouriteFilterValue**:\n  - `0` = only return un-favorited items\n  - `1` = only return favorited items\n- **searchFilter**:\n  - `true` will use the `searchFilterString` value to get articles with that value in the URL or title.\n  - `false` will ignore the `searchFilterString` value\n- **searchFilterString**: If `searchFilter` is true then get articles with this value in the URL or title.\n- **domainFilter**:\n  - `true` will use the `domainFilterString` value to get articles for that domain.\n  - `false` will ignore the `domainFilterString` value\n- **domainFilterString**: If `domainFilter` is true then get articles from this domain.\n\n## How to query your Pocket articles data using GraphQL\n\nBelow is a sample query for fetching all Article nodes.\n\n```graphql\nquery PageQuery {\n  allPocketArticle(sort: { fields: readWeek }) {\n    edges {\n      node {\n        id\n        url\n        title\n        favourite\n        excerpt\n        is_article\n        is_index\n        has_video\n        has_image\n        word_count\n        tags\n        time_read\n        readDay\n        readWeek\n        articleDomain\n        domainFavicon\n        image {\n          item_id\n          src\n          width\n          height\n        }\n      }\n    }\n  }\n}\n```\n\n## Author\n\nThis plugin contains code or other contributions of the open source community. The original code was written by Conrad Jackson who maintained it since March 13, 2018 at https://github.com/conradj/gatsby-source-pocket. On February 5, 2023 the project has moved, with approval of Conrad, to https://github.com/Vacilando/gatsby-source-pocketapi where it continues to this day. Thank you again, @conradj, for your trust and a chance to steer the development of this plugin into the future.\n\n## Examples\n\nAn example site for this plugin is available:\n\n- **[Demo](https://conradj.co.uk/weeklyreads/)**\n- **[Example site source code](https://github.com/conradj/pocket-public-archive)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvacilando%2Fgatsby-source-pocketapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvacilando%2Fgatsby-source-pocketapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvacilando%2Fgatsby-source-pocketapi/lists"}