Skip to content

add SN13 OnDemand API, remove the bug from SN1 usage example. #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 29, 2025
Merged

add SN13 OnDemand API, remove the bug from SN1 usage example. #12

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9fcf7e4
Remove n_results from a docs as it's not avaiable in docs API:
Arrmlet May 28, 2025
d1638ff
Add the OnDemandAPI from sn13.
Arrmlet May 28, 2025
e457b99
replace r with R
Arrmlet May 28, 2025
ecddb0b
Replace: n_results to n_results_per_miner
Arrmlet May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,37 @@ import macrocosmos as mc
client = mc.ApexClient(api_key="<your-api-key>")
response = client.web_search.search(
search_query="What is Bittensor?",
n_results=3,
max_results_per_miner=3,
max_response_time=20,
)

print(response)
```

## SN13 OnDemandAPI

SN13 is focused on large-scale data collection. With the OnDemandAPI, you can run precise, real-time queries against platforms like X (Twitter) and Reddit (YouTube forthcoming).

Use the synchronous `Sn13Client` to query historical or current data based on users, keywords, and time range.

### Query Example

```py
import macrocosmos as mc

client = mc.Sn13Client(api_key="<your-api-key>")

response = client.sn13.OnDemandData(
source='X', # or 'Reddit'
usernames=["@nasa"], # Optional, up to 5 users
keywords=["galaxy"], # Optional, up to 5 keywords
start_date='2025-04-15', # Defaults to 24h range if not specified
end_date='2025-05-15', # Defaults to current time if not specified
limit=1000 # Optional, up to 1000 results
)

print(response)
```

## Gravity
Gravity is a decentralized data collection platform powered by Subnet 13 (Data Universe) on the Bittensor network. You can read more about this subnet on the [Macrocosmos Data Universe page](https://www.macrocosmos.ai/sn13).
Expand Down