{"id":15289236,"url":"https://github.com/conradj/gatsby-source-pocket","last_synced_at":"2025-10-07T03:31:00.833Z","repository":{"id":45647008,"uuid":"125053431","full_name":"conradj/gatsby-source-pocket","owner":"conradj","description":"Fetch data from Pocket API","archived":true,"fork":false,"pushed_at":"2023-02-19T23:20:03.000Z","size":352,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-01T15:59:51.734Z","etag":null,"topics":["gatsby","gatsby-plugin","gatsbyjs","pocket-api"],"latest_commit_sha":null,"homepage":null,"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/conradj.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}},"created_at":"2018-03-13T13:09:54.000Z","updated_at":"2024-02-27T00:18:24.000Z","dependencies_parsed_at":"2023-02-08T13:45:26.776Z","dependency_job_id":null,"html_url":"https://github.com/conradj/gatsby-source-pocket","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conradj%2Fgatsby-source-pocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conradj%2Fgatsby-source-pocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conradj%2Fgatsby-source-pocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conradj%2Fgatsby-source-pocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conradj","download_url":"https://codeload.github.com/conradj/gatsby-source-pocket/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235581534,"owners_count":19013089,"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":["gatsby","gatsby-plugin","gatsbyjs","pocket-api"],"created_at":"2024-09-30T15:59:56.821Z","updated_at":"2025-10-07T03:30:55.263Z","avatar_url":"https://github.com/conradj.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"**☠️ THIS PROJECT IS NO LONGER MAINTAINED ☠️**\n\n**Please use [gatsby-source-pocketapi](https://github.com/Vacilando/gatsby-source-pocketapi) instead 🚀**\n\n\n---\n\n\n\n\n\n\n# gatsby-source-pocket (deprecated)\n\nFetch data from Pocket API.\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\n## Breaking changes\n\n- v3.x - for `Gatsby@4`\n- v2.x - for `Gatsby@3` and lower\n\n## How to Use\n\n1.  `npm install --save gatsby-source-pocket`\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:8080to 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-pocket`,\n      options: {\n        consumerKey: INSERT_HERE_YOUR_POCKET_CONSUMER_KEY,\n        accessToken: INSERT_HERE_YOUR_POCKET_ACCESS_TOKEN,\n        weeksOfHistory: 52,\n        apiMaxRecordsToReturn: 3000,\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**: Limit the number of records to return, to stop you hitting your [api limit](https://getpocket.com/developer/docs/rate-limits).\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconradj%2Fgatsby-source-pocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconradj%2Fgatsby-source-pocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconradj%2Fgatsby-source-pocket/lists"}