Modrinth

[NatoBoram]

📋 Description

Service : https://modrinth.com

This is the kind of information that should be shown by the new badges

Example :

• Modrinth
• https://api.modrinth.com/api/v1/mod/wq6HaMZG
• #5da426
• downloads

🔗 Data

https://github.com/modrinth/labrinth/wiki

https://api.modrinth.com/api/v1/mod/wq6HaMZG

🎤 Motivation

In my case, I want to show off the downloads of my mod on a specific platform, Modrinth.

• Badge request: Curseforge #4498

[chris48s]

I can't see any docs explicitly explaining rate limit. https://api.modrinth.com/ gives a documentation link https://modrinth.com/documentation but its a 404.

If I call curl "https://api.modrinth.com/api/v1/mod/wq6HaMZG" --include the headers include

x-ratelimit-limit: 200
x-ratelimit-remaining: 197
x-ratelimit-reset: 59

so it looks like anonymous usage is subject to some fairly restrictive rate limiting. Are you able to link to any docs about rate limits? I think if we were going to take on this integration we'd need to understand this constraint in more detail.

[NatoBoram]

I think rate limits were added there:

• Rate limiting + version fixes modrinth/labrinth#90

But the only thing I found was that.

.wrap(Logger::new("%a %{User-Agent}i"))
.wrap(
	RateLimiter::new(MemoryStoreActor::from(store.clone()).start())
		.with_interval(std::time::Duration::from_secs(60))
		.with_max_requests(100),
)

I think it means 100 requests per 60 seconds for each user agents? I'm not sure, since lots of people can have the same user agent.

@wafflecoffee, do you know where are rate limits documented on Modrinth?

I've added an issue so it's easier to find in the future.

• Document rate limits modrinth/docs#7

[triphora]

The ratelimit is per minute, so it's actually rather liberal (regulated by Cloudflare). We can add information on this to our docs site soon enough, but it's still very work in progress :)

P.S.: There are also some rudimentary unofficial badge generators for Modrinth already. See https://modrinth-utils.vercel.app

[chris48s]

Aah I thought the rate limits may be per hour or minute. 200 reqs per second is no issue 👍

[BrenekH]

Is this issue available to pick up? I'd be willing to work on it if no one else is already doing it.

[chris48s]

@BrenekH - feel free to pick it up. Our guide for adding new badges is at https://github.com/badges/shields/blob/master/doc/TUTORIAL.md

I think the issue contains all the info needed to work on this. Although when it comes to colours, shields.io uses colours semantically (to convey information) rather than for branding purposes i.e:

• 
• 
• 

etc

so a semantic colour scheme should be used by default rather than #5da426

[dominikbrandon]

A few days have passed and no solution was presented so I assumed this issue is abandoned. Therefore I've opened the PR for that - #7132. Please let me know what are your thoughts.

[dominikbrandon]

@NatoBoram this has been merged just now. Feel free to use the new badge!

[calebcartwright]

Resolved via #7132