asa-query is a powerful and flexible tool designed to query Ark: Survival Ascended servers. It was created to provide a simple yet specific way to retrieve server information. The tool uses a Query Builder structure, allowing users to build complex queries with ease.
Provided below are instructions to initiate and start using asa-query. We assume you have a basic understanding of Node.js, but also try to keep it as "noob" friendly as possible.
Begin by installing the asa-query package with your chosen Node package manager
npm install asa-queryyarn add asa-querypnpm add asa-queryOnce you've obtained the package, import it in to your project. This can be done with either imports or require(), depending on how you've setup your project/environment.
import AsaQuery from 'asa-query';
or
const AsaQuery = require('asa-query');
You're now ready to use asa-query!
Let's take a look at an example usage.
import AsaQuery from 'asa-query';
const query = new AsaQuery();
const main = async () => {
const res = query.official().serverNameContains("2142").exec();
console.log(res);
};
main();
In the above example, we're querying for any official servers in which the server name contains the string "2142".
This will return us a sessions array with the matching severs, and a count element, with the total count.
These are the available methods on the AsaQuery class.
Adds a criterion to the query.
Parameters:
key (CriterionKey): The key of the criterion. This corresponds to a specific attribute of a server.op ('EQUAL' | 'NOT_EQUAL' | 'CONTAINS'): The operation to perform on the key. This can be 'EQUAL', 'NOT_EQUAL', or 'CONTAINS'.value (string | number | boolean): The value to compare the key against.Returns:
AsaQuery instance, allowing for method chaining.Example:
// Add a criterion for servers with a specific name
query.addCriteria('attributes.SERVERNAME_s', 'EQUAL', 'My Servers Name');
const res = query.exec();
Filters for an exact server name
Parameters:
name (String) - The exact name of the server(s) to return.Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for servers with the exact name: "NA-PVP-TheIsland2142"
query.serverName('NA-PVP-TheIsland2142');
const res = query.exec();
Filters for servers with a name that contains the given string
Parameters:
name (String) - The string that exists in the servers name.Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for servers with a name containing the text: "2142"
query.serverNameContains('2142');
const res = query.exec();
Filters for official servers only.
Parameters:
None
Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for servers on the official network
query.official();
const res = query.exec();
Filters for unofficial servers only.
Parameters:
None
Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for unofficial servers, not on the official network.
query.unofficial();
const res = query.exec();
Filters for servers with the given Epic Session (Server) ID.
Parameters:
id (string) - The Epic Session/server ID of the server.Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for servers with the ID: 69ee7eab580f43eeb904527d439b8fae
query.serverId("69ee7eab580f43eeb904527d439b8fae");
const res = query.exec();
Specifies the maximum amount of servers to return, defaults to 10.
Parameters:
max (number) - The amount of servers to return.Returns:
AsaQuery instance, allowing for method chaining.Example:
// filter for servers with a name containing "42"
// limit the response to 100 servers.
query.serverNameContains("42").max(100);
const res = query.exec();
Allows you to get a custom access_token to use for the authentication instead of using the ones provided by Ark (default)
Parameters:
max (number) - The amount of servers to return.client_id (string) - the JWT client IDclient_secret (string) - The JWT client secretdeployment_id (string) - The deployment ID (ASA servers)api_endpoint (string) - The API endpoint (Epic Games API)Returns:
AsaQuery instance, allowing for method chaining.Example:
// Returns the server with the specified ID.
// Authenticates the request using the provided credentials
const options = {
client_id: 'xyza7891muomRmynIIHaJB9COBKkwj6n',
client_secret: 'PP5UGxysEieNfSrEicaD1N2Bb3TdXuD7xHYcsdUHZ7s',
deployment_id: 'ad9a8feffb3b4b2ca315546f038c3ae2',
api_endpoint: 'https://api.epicgames.dev',
};
const res = query
.getToken(options)
.serverId("69ee7eab580f43eeb904527d439b8fae");
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)Distributed under the AGPL-3.0 License. See LICENSE for more information.
Feel free to reach out to me:
FAQs
A simple way to query ARK: Survival Ascended's server list
The npm package asa-query receives a total of 7 weekly downloads. As such, asa-query popularity was classified as not popular.
We found that asa-query demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.