Compare Revisions

The generic AMO API

Change Revisions

Revision 49531:

Revision 49531 by Sheppy on

Revision 49532:

Revision 49532 by Sheppy on

Title:
The generic AMO API
The generic AMO API
Slug:
addons.mozilla.org_(AMO)_API_Developers'_Guide/The_generic_AMO_API
addons.mozilla.org_(AMO)_API_Developers'_Guide/The_generic_AMO_API
Tags:
Add-ons, "AMO API", AMO
Add-ons, "AMO API", AMO
Content:

Revision 49531
Revision 49532
n146    <dl>n146    <p>
147      <dt>147      Returns a randomly ordered and selected list of add-ons.
148    </p>
149    <h4>
148        Prototype:150      Prototype
151    </h4>
152    <p>
153      <code><span class="nowiki">https://services.addons.mozilla.
 >org/api/[version]/list/[optional:listtype]/[optional:addontype]/[
 >optional:number]/[optional:list_os]/[optional:list_version]</span
 >></code>
154    </p>
155    <h4>
156      Parameters
157    </h4>
158    <dl>
149      </dt>159      <dt>
150      <dd>160        listtype
151        <span class="nowiki">https://services.addons.mozilla.org/
>api/[version]/list/[optional:listtype]/[optional:addontype]/[opti 
>onal:number]/[optional:list_os]/[optional:list_version]</span> 
152      </dd>
153      <dt>161      </dt>
154        Purpose
155      </dt>
156      <dd>
157        Returns a random order and selection list of addons.<br>
158        Note that a maximum of 10 results will be returned.
159      </dd>162      <dd>
160      <dt>163        The type of list to return. The default is <code>recommen
 >ded</code>; the only other possible value is <code>new</code>. Re
 >commended add-ons are those recommended by AMO editors, while new
 > add-ons are those posted in the last ten days.
161        Parameters
162      </dt>
163      <dd>164      </dd>
164        <dl>
165          <dt>
166            listtype
167          </dt>
168          <dd>
169            The type of list.&nbsp; Default is 'recommended'.&nbs
>p; Possible values are 'recommended' or 'new'.&nbsp; New addons h 
>ave been posted in the last ten days.&nbsp; Recommended addons ar 
>e from the list recommended by AMO editors. 
170          </dd>
171          <dt>
172            addontype
173          </dt>
174          <dd>
175            Type of add os to return. Default is 'all'.&nbsp; Pos
>sible values are 'all', 'extension', 'theme', 'plugin', 'dictiona 
>ry', 'searchengine'. 
176          </dd>
177          <dt>
178            number
179          </dt>
180          <dd>
181            The maximum number of results to return.&nbsp; Defaul
>t is 3. 
182          </dd>
183          <dt>
184            list_os
185          </dt>
186          <dd>
187            Return addons matching the specified OS. Possible val
>ues are 'all', 'winnt', 'darwin', 'linux'. 
188          </dd>
189          <dt>
190            list_version
191          </dt>
192          <dd>
193            Return results that match the specified application v
>ersion. 
194          </dd>
195        </dl>
196      </dd>
197      <dt>
198        Example invocations
199      </dt>165      <dt>
200      <dd>166        addontype
201        <span class="nowiki">https://services.addons.mozilla.org/
>en-US/firefox/api/1.3/list/new/</span> 
202      </dd>
203      <dt>167      </dt>
204        Example return data
205      </dt>168      <dd>
169        The types of add-on to return. The default value is <code
 >>all</code>, but you may specify <code>extension</code>, <code>th
 >eme</code>, <code>plugin</code>, <code>directory</code>, or <code
 >>searchengine</code>.
206      <dd>170      </dd>
171      <dt>
172        number
173      </dt>
174      <dd>
175        The maximum number of results to return; the default valu
 >e is 3. This value is capped at 10; if you specify a higher value
 > than 10, no more than ten results are returned.
176      </dd>
177      <dt>
178        list_os
179      </dt>
180      <dd>
181        The operating system for which compatible add-ons should 
 >be returned. By default, this is <code>all</code>. You may also s
 >pecify <code>winnt</code>, <code>darwin</code>, or <code>linux</c
 >ode>.
182      </dd>
183      <dt>
184        list_version
185      </dt>
186      <dd>
187        The application version with which the returned add-ons m
 >ust be compatible.
188      </dd>
189    </dl>
190    <dl>
191      <dd>
192        <h4>
193          Example
194        </h4>
n208  [sample]n196<span class="plain">https://services.addons.mozilla.org/en-US/fir
 >efox/api/1.3/list/new/</span>
tt198        <p>
199          Returns a list of new add-ons. <a class="link-https" hr
 >ef="https://services.addons.mozilla.org/en-US/firefox/api/1.3/lis
 >t/new/" title="https://services.addons.mozilla.org/en-US/firefox/
 >api/1.3/list/new/">See the output from this request</a>.
210      </dd>200        </p>
211    </dl>
212    <h3>201        <h3>
213      cumulative_downloads202          cumulative_downloads
214    </h3>203        </h3>
215    <p>204        <p>
216      This API call is currently disabled.205          This API call is currently disabled.
217    </p>206        </p>
218    <h3>207        <h3>
219      update_pings208          update_pings
220    </h3>209        </h3>
221    <p>210        <p>
222      This API call is currently disabled.211          This API call is currently disabled.
212        </p>
213      </dd>
223    </p>214    </dl>

Back to History