at.marque.partner.checkAvailability
Schema Diff
+1 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Check up to 500 domains at once. Call it proxied through the user's PDS (atproto-proxy: did:web:marque.at:api#marque_registrar) with an at.marque.partnerApi-scoped token. Each result carries its own error field, so a single bad domain does not fail the batch. Prices are in whole US dollars and are indicative; the binding amount is set when createCheckout builds the Stripe session. Premium domains are flagged with isPremium and priced via premiumPrice.",
5
+
"description": "Check up to 500 domains at once. Call it proxied through the user's PDS (atproto-proxy: did:web:marque.at#marque_registrar) with an at.marque.partnerApi-scoped token. Each result carries its own error field, so a single bad domain does not fail the batch. Prices are in whole US dollars and are indicative; the binding amount is set when createCheckout builds the Stripe session. Premium domains are flagged with isPremium and priced via premiumPrice.",
6
6
"output": {
7
7
"encoding": "application/json",
8
8
"schema": {
9
9
"properties": {
10
10
"results": {
11
11
"description": "One result per domain, in request order; blank entries are skipped.",
12
12
"items": {
13
13
"ref": "#result",
14
14
"type": "ref"
15
15
},
16
16
"type": "array"
17
17
}
18
18
},
19
19
"required": [
20
20
"results"
21
21
],
22
22
"type": "object"
23
23
}
24
24
},
25
25
"parameters": {
26
26
"properties": {
27
27
"domains": {
28
28
"description": "Fully qualified domain names to check, e.g. example.com.",
29
29
"items": {
30
30
"maxLength": 253,
31
31
"type": "string"
32
32
},
33
33
"maxLength": 500,
34
34
"minLength": 1,
35
35
"type": "array"
36
36
}
37
37
},
38
38
"required": [
39
39
"domains"
40
40
],
41
41
"type": "params"
42
42
},
43
43
"type": "query"
44
44
},
45
45
"result": {
46
46
"properties": {
47
47
"available": {
48
48
"description": "Whether the domain can be registered now. True when status is free or premium.",
49
49
"type": "boolean"
50
50
},
51
51
"domain": {
52
52
"description": "The fully qualified domain name that was checked, lowercased.",
53
53
"maxLength": 253,
54
54
"type": "string"
55
55
},
56
56
"error": {
57
57
"description": "Per-domain failure reason when the domain could not be checked or priced, e.g. invalid format, unsupported TLD, or not available via the registrar. When set, the pricing fields are absent or zero.",
58
58
"type": "string"
59
59
},
60
60
"isPremium": {
61
61
"description": "Whether this is a premium domain, priced individually by the registry rather than at the standard TLD price.",
62
62
"type": "boolean"
63
63
},
64
64
"maxPeriod": {
65
65
"description": "Maximum registration period in years for this TLD.",
66
66
"type": "integer"
67
67
},
68
68
"minPeriod": {
69
69
"description": "Minimum registration period in years for this TLD.",
70
70
"type": "integer"
71
71
},
72
72
"premiumPrice": {
73
73
"description": "Premium registration price, in whole US dollars, when isPremium is true.",
74
74
"type": "integer"
75
75
},
76
76
"price": {
77
77
"description": "Registration price per year, in whole US dollars. Absent for unavailable or errored domains.",
78
78
"type": "integer"
79
79
},
80
80
"renewPrice": {
81
81
"description": "Renewal price per year, in whole US dollars.",
82
82
"type": "integer"
83
83
},
84
84
"status": {
85
85
"description": "Registry status of the domain: free (available), premium (available at a premium price), or active (already registered, not available). Absent when the domain could not be checked (see error).",
86
86
"knownValues": [
87
87
"free",
88
88
"premium",
89
89
"active"
90
90
],
91
91
"type": "string"
92
92
},
93
93
"transferAddsYear": {
94
94
"description": "Whether transferring this TLD adds a year of registration (and so is charged).",
95
95
"type": "boolean"
96
96
},
97
97
"transferPrice": {
98
98
"description": "Transfer price, in whole US dollars. 0 when transferring this TLD does not cost a registration period.",
99
99
"type": "integer"
100
100
},
101
101
"whoisPrivacyAllowed": {
102
102
"description": "Whether WHOIS privacy can be enabled for this TLD at registration.",
103
103
"type": "boolean"
104
104
}
105
105
},
106
106
"required": [
107
107
"domain",
108
108
"available"
109
109
],
110
110
"type": "object"
111
111
}
112
112
},
113
113
"description": "Check availability and pricing for a batch of domains, for partner integrations.",
114
114
"id": "at.marque.partner.checkAvailability",
115
115
"lexicon": 1
116
116
}