> For the complete documentation index, see [llms.txt](https://docs.rubyscore.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rubyscore.io/for-partners/rubyscore-api/core-api-methods.md).

# Core API Methods

The easiest way to integrate with **RubyScore** is via our **REST API** .\
Review the [**Swagger** **docs**](https://rubyscore.io/public_api/api-docs) and submit the short [**access request form**](https://forms.gle/wodhXkB1RFsvav3W8). We’ll follow up quickly, clarify your use case, and grant **partial test access** (sandbox/limited methods) so you can validate the integration.\
After a successful test, we’ll issue **full production API keys!**

### Below is a compact reference of RubyScore’s core API resources.

* **Wallet Data**
* **Score Data**
* **Network Data**
* **RubyID**
* **Score Level**
* **Multichain**

The RubyScore API is **not limited** to the requests shown above — these are only **baseline examples**.\
On request, we can define and deliver **custom blockchain and wallet signals**, and tailor metrics, filters, and endpoints to your specific needs.

***

## Wallet Data

**What it is:** data about a single wallet in one or multiple networks.\
**What you can get:**

* **Basics:** checksum address, wallet “age,” first/last on-chain event, labels/tags.
* **Balances:** native assets and ERC-20 (quoted in USD/ETH), NFT holdings (ERC-721/1155).
* **Activity:** total transactions, active days/weeks/months, gas spent, unique contracts touched.
* **Volumes & flows:** inflows/outflows, net flows, action categories (DeFi/NFT/Bridge/DAO).
* **Counterparties:** top addresses by count/volume, interaction routes.

**Use cases:** user profiling, anti-fraud signals, personalization, campaign attribution.

***

## Score Data

**What it is:** reputation assessments.\
**What you can get:**

* **Reputation score:**
  * **MRS (0–1000):** the wallet’s multichain reputation score.
* **Eligibility checks:**
  * **PoH ID** eligibility.
  * **Score Level** eligibility.

*Custom scores can be defined on request (your weights, thresholds, and signals).*

**Use cases:** gating/allowlists, reward rules, quality-based segmentation, anti-bot/Sybil filtering.

***

## Network Data

**What it is:** network-level slices and telemetry.\
**What you can get:**

* **Core metrics:** active/new addresses, tx count, volumes, gas usage.
* **Tokens/contracts:** top tokens, trending contracts, notable events.
* **Extended views** (where available): DEX volumes, NFT collections, governance, bridge flows.

**Use cases:** ecosystem comparisons, campaign planning, network health monitoring.

***

## Multichain

**What it is:** aggregated wallet data **across multiple networks**.\
**What you can get:**

* **Consolidated balances and volumes** by chain.
* **Cross-chain activity:** days/weeks/months active, unique contracts, tx count.
* **Reputation consolidation:** current **MRS**, presence of **RubyID** per ecosystem, **max Score Level**.
* **Top counterparties and main routes** across all supported networks.

**Use cases:** 360° user profiles, multichain targeting, anti-bot filters, cross-chain analytics.

***

## RubyScore ID

**What it is:** **PoH ID** — an SBT “proof-of-human” passport within a specific ecosystem.\
**What you can do:**

* Check **eligibility** (points/level within the ecosystem).
* See whether **PoH ID is minted** and whether badges/levels are present (if applicable).

**Use cases:** access to campaigns/quests, proof of real participation, local privileges.

***

## Score Level

**What it is:** **10 levels (1–10)** — non-transferable SBT artifacts of wallet progress in a given ecosystem.\
**What you can do:**

* Retrieve the **highest minted level**.
* Check **eligibility** for the next level (activity threshold).
* See whether a **level is minted**.

**Use cases:** gamified progression, access tiers, segmentation of power users.

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rubyscore.io/for-partners/rubyscore-api/core-api-methods.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
