Skip to content

Class guides (no key)

GET
/api/guides
curl -X GET "https://api.valjeanspecialty.com/api/guides"

The classes Valjean publishes guidance for. Cached for an hour.

No key needed.

OK

Media typeapplication/json
object
guides
required
Array<object>
object
key
required
string
name
required
string
class
required
string
line
required
string
line_name
required
string
naics_prefixes
required
Array<string>
keywords
required
Array<string>

Example generated

{
"guides": [
{
"key": "example",
"name": "example",
"class": "example",
"line": "example",
"line_name": "example",
"naics_prefixes": [
"example"
],
"keywords": [
"example"
]
}
]
}

Too many requests (rate_limited): 120 a minute per key, 30 a minute per IP on public endpoints, counted across all of Valjean’s servers. Wait Retry-After seconds.

Media typeapplication/json
object
error
required
object
code
required

Machine-readable code, e.g. invalid_request, read_only, not_found, closed, rate_limited.

string
message
required

Plain-English explanation you can show a person.

string
issues

Validation problems, as “field: problem” (400 invalid_request only).

Array<string>

Example

{
"error": {
"code": "rate_limited",
"message": "Too many requests. Try again in a minute."
}
}
Retry-After
integer
Example
60

Seconds to wait.