X API & Twitter API Plugin for Strapi 5

Xquik is the world's fastest and cheapest X Twitter data API with the most complete X data. Searches & extractions charge only for delivered, unique, filter-matching results.

Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp. Xquik makes this plugin. Strapi doesn't make or endorse it.

This plugin adds an xquik service to your Strapi 5 server. The service searches X posts & reads X profiles. It runs on the server only. It adds no admin pages, routes or content types.

Requirements

• Strapi 5
• Node.js 20 to 26
• An Xquik API key from your dashboard at xquik.com

Install

npm install strapi-plugin-xquik

Strapi 5 enables the plugin on its next start.

Configure

Add your API key to your app's .env file.

XQUIK_API_KEY=xq_...

The plugin reads XQUIK_API_KEY by default. To set the key another way, set apiKey in config/plugins.js.

module.exports = ({ env }) => ({
  xquik: {
    config: {
      apiKey: env("XQUIK_API_KEY"),
    },
  },
});

The plugin reads the key on each call. With no key, a call fails before it sends a request.

Search posts

Call the service from any controller, service or lifecycle hook.

const page = await strapi
  .plugin("xquik")
  .service("xquik")
  .searchPosts({ q: "from:NASA", limit: 10 });

searchPosts(query) takes these fields.

It also passes every other search filter in the search API reference. Examples are language, minLikes, sinceDate & untilDate. q takes X search operators, such as from: & since:.

It returns { tweets, has_next_page, next_cursor }. Each post has an id. It also has fields such as text, createdAt, likeCount, viewCount & author.

To read the next page, pass next_cursor as cursor with the same filters. Stop when has_next_page is false.

Read a profile

const profile = await strapi.plugin("xquik").service("xquik").getUser("NASA");

getUser(id) takes a user ID, a username with or without @, or a profile URL such as x.com/nasa. It returns the profile with id, username & name. It also has fields such as description, followers, following & verified. The profile API reference lists every field.

Handle errors

Each failure throws an XquikError. Its code names the failure. Its status holds the HTTP status when the API answered.

Other API errors keep the API's own code & message. The API reference lists every code.

This controller returns search results & turns an XquikError into a JSON error.

module.exports = ({ strapi }) => ({
  async search(ctx) {
    try {
      ctx.body = await strapi
        .plugin("xquik")
        .service("xquik")
        .searchPosts({ q: ctx.query.q, limit: 10 });
    } catch (error) {
      if (error.name !== "XquikError") {
        throw error;
      }
      ctx.status = error.status ?? 500;
      ctx.body = { error: { code: error.code, message: error.message } };
    }
  },
});

Develop

bin/check-local

bin/check-local runs every check in order. It installs, then checks format, lint, types & tests. It builds & verifies the plugin, then runs npm audit & npm pack --dry-run. Last, it starts a fresh Strapi 5 app with the packed plugin & calls the service over HTTP. With XQUIK_API_KEY set, that last check calls the live API.

License

MIT