{"id":16616133,"url":"https://github.com/vladimyr/wp-api-client","last_synced_at":"2025-03-11T02:25:41.240Z","repository":{"id":74181783,"uuid":"158752554","full_name":"vladimyr/wp-api-client","owner":"vladimyr","description":"WordPress API client for node","archived":false,"fork":false,"pushed_at":"2018-11-24T19:53:03.000Z","size":205,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-27T03:02:40.399Z","etag":null,"topics":["nodejs","wordpress","wordpress-rest-api"],"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/vladimyr.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":"2018-11-22T21:42:58.000Z","updated_at":"2018-11-24T20:11:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"4b0ed7e9-0add-4a4e-a7f5-e098c753cfff","html_url":"https://github.com/vladimyr/wp-api-client","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimyr%2Fwp-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimyr%2Fwp-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimyr%2Fwp-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimyr%2Fwp-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vladimyr","download_url":"https://codeload.github.com/vladimyr/wp-api-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242958006,"owners_count":20212706,"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":["nodejs","wordpress","wordpress-rest-api"],"created_at":"2024-10-12T02:11:58.045Z","updated_at":"2025-03-11T02:25:41.213Z","avatar_url":"https://github.com/vladimyr.png","language":"JavaScript","readme":"# wp-api-client [![build status](https://badgen.net/travis/vladimyr/wp-api-client/master)](https://travis-ci.com/vladimyr/wp-api-client) [![install size](https://badgen.net/packagephobia/install/wp-api-client)](https://packagephobia.now.sh/result?p=wp-api-client) [![npm package version](https://badgen.net/npm/v/wp-api-client)](https://npm.im/wp-api-client) [![github license](https://badgen.net/github/license/vladimyr/wp-api-client)](https://github.com/vladimyr/wp-api-client/blob/master/LICENSE) [![js semistandard style](https://badgen.net/badge/code%20style/semistandard/cyan)](https://github.com/Flet/semistandard)\n\n\u003e WordPress API client for node\n\n## Installation\n\n    $ npm i wp-api-client\n\n## Usage\n\n```js\nconst WordPressClient = require('wp-api-client');\n\n// Create API client for WordPress blog\nconst client = new WordPressClient('https://wordpress.org/news');\n\n// Fetch latest post\nclient.fetchPosts()\n  .then(({ items }) =\u003e {\n    const { title, link } = items[0];\n    console.log(`\"${title}\": ${link}`);\n  });\n```\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n#### Table of Contents\n\n-   [WordPressClient](#wordpressclient)\n    -   [Parameters](#parameters)\n    -   [fetchPosts](#fetchposts)\n        -   [Parameters](#parameters-1)\n    -   [fetchPost](#fetchpost)\n        -   [Parameters](#parameters-2)\n    -   [countPosts](#countposts)\n        -   [Parameters](#parameters-3)\n    -   [fetchPages](#fetchpages)\n        -   [Parameters](#parameters-4)\n    -   [fetchPage](#fetchpage)\n        -   [Parameters](#parameters-5)\n    -   [countPages](#countpages)\n        -   [Parameters](#parameters-6)\n-   [Page](#page)\n-   [Post](#post)\n-   [Response](#response)\n    -   [Properties](#properties)\n-   [Item](#item)\n    -   [Properties](#properties-1)\n\n### WordPressClient\n\nCreate new WordPress REST API client.\u003cbr\u003e\n:blue_book: Documentation: \u003chttps://developer.wordpress.org/rest-api/reference/\u003e\n\n#### Parameters\n\n-   `url` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Url of WordPress installation.\n\n#### fetchPosts\n\nList posts from target site.\n\n##### Parameters\n\n-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/posts/#arguments).\n    -   `options.pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items to be returned in result set. (optional, default `10`)\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Response](#response)\u0026lt;[Post](#post)\u003e\u003e** Paginated listing of posts.\n\n#### fetchPost\n\nRetrieve single post from target site.\n\n##### Parameters\n\n-   `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object.\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Post](#post)\u003e** `Post` with requested `id`.\n\n#### countPosts\n\nCount all available posts.\n\n##### Parameters\n\n-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/posts/#arguments).\n\nReturns **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available posts.\n\n#### fetchPages\n\nList pages from target site.\n\n##### Parameters\n\n-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/pages/#arguments).\n    -   `options.pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items to be returned in result set. (optional, default `10`)\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Response](#response)\u0026lt;[Page](#page)\u003e\u003e** Paginated listing of pages.\n\n#### fetchPage\n\nRetrieve single page from target site.\n\n##### Parameters\n\n-   `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u0026lt;[Page](#page)\u003e** `Page` with requested `id`.\n\n#### countPages\n\nCount all available pages.\n\n##### Parameters\n\n-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/pages/#arguments).\n\nReturns **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available pages.\n\n### Page\n\nType: [Item](#item)\n\n### Post\n\nType: [Item](#item)\n\n### Response\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n#### Properties\n\n-   `total` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available items.\n-   `totalPages` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of pages.\n-   `pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items returned in result set.\n-   `items` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;T\u003e** Items returned in current result set.\n\n### Item\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n#### Properties\n\n-   `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object.\n-   `createdAt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item creation date.\n-   `modifiedAt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Last modification date.\n-   `link` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Url of an item.\n-   `title` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's title in html format.\n-   `excerpt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's excerpt in html format.\n-   `content` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's content in html format.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvladimyr%2Fwp-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvladimyr%2Fwp-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvladimyr%2Fwp-api-client/lists"}