Deployed 7004211 with MkDocs version: 1.4.2

Author: ccaputo

howto/peeringdb-py/index.html

@@ -164,11 +164,11 @@
 
 <h1 id="howto-install-peeringdb-py">HOWTO: Install peeringdb-py</h1>
 <p>You can install <code>peeringdb-py</code> on a wide selection of operating systems. Users have installed it on several Linux distributions, macOS, and Windows Subsystem for Linux.</p>
-<p>It will give you a local version of PeeringDB’s SQL database. Unlike the PeeringDB API, the SQL data structure might change without notice. Please do not build tools that make SQL queries. We suggest using our library to make <a href="https://docs.peeringdb.com/api_specs/">API calls</a> on your local cache. We maintain the library and commit to maintaining the API functionality, even if the underlying database structure changes.</p>
+<p>It will give you a local version of PeeringDB’s SQL database. Unlike the PeeringDB API, the SQL data structure might change without notice. Please do not build tools that make SQL queries. We suggest using our library to make <a href="/api_specs/">API calls</a> on your local cache. We maintain the library and commit to maintaining the API functionality, even if the underlying database structure changes.</p>
 <p>Please let us know if you find a query that is only possible with SQL and not via the API. Either create an issue in <a href="https://github.com/peeringdb/peeringdb/issues">GitHub</a>, or send a mail describing the problems to <a href="mailto:support@peeringdb.com">support@peeringdb.com</a>.</p>
 <h2 id="peeringdb-credentials">PeeringDB credentials</h2>
 <p>You only need a PeeringDB account if you want to synchronize the contact information to your peeringdb-py cache. If you want to synchronize the whole database, including the contact data, you will need an API Key.</p>
-<p>If you are installing peeringdb-py for organizational use you should use an organizational API Key. You can use an API Key tied to a user account for personal use. We have a <a href="/howto/api_keys/">HOWTO guide for API Keys</a>.</p>
+<p>If you are installing peeringdb-py for organizational use you should use an organizational API Key. You can use an API Key tied to a user account for personal use. We have a <a href="/howto/api_keys">HOWTO guide for API Keys</a> and a <a href="/howto/work_within_peeringdbs_query_limits/#local-cache-peeringdb-py">HOWTO guide for working with PeeringDB's query limits</a>.</p>
 <h2 id="software-requirements">Software requirements</h2>
 <p>You must ensure these these packages are installed to install and use <code>peeringdb-py</code>:<br />
 - git<br />

howto/work_within_peeringdbs_query_limits/index.html

@@ -143,7 +143,7 @@
               <ul class="nav flex-column">
               </ul>
             </li>
-            <li class="nav-item" data-level="2"><a href="#local-cache" class="nav-link">Local cache</a>
+            <li class="nav-item" data-level="2"><a href="#local-cache-peeringdb-py" class="nav-link">Local cache – peeringdb-py</a>
               <ul class="nav flex-column">
               </ul>
             </li>
@@ -173,7 +173,7 @@ <h2 id="query-limits">Query limits</h2>
 <p>Query rate limit:</p>
 <ul>
 <li>Anonymous queries limited to 20/minute per IP address</li>
-<li>Authenticated queries limited to 40/minute per user or organization (when an organizational <a href="/howto/api_keys/">API key</a> is used)</li>
+<li>Authenticated queries limited to 40/minute per user or organization (when an organizational <a href="/howto/api_keys">API key</a> is used)</li>
 </ul>
 <h2 id="efficient-queries">Efficient queries</h2>
 <p>We encourage users to make fewer, larger queries instead of making many small queries.</p>
@@ -182,10 +182,10 @@ <h2 id="efficient-queries">Efficient queries</h2>
 <p>We encourage sending lists of up to 150 ASNs in a single query. We have a <a href="/howto/search">HOWTO article</a> describing the basics of using our API using popular command line tools such as curl, Python, and jq.</p>
 <p>Please use API Keys when automating queries to PeeringDB and set a User-Agent header that identifies the unique software you are using, rather than just a generic query library name.</p>
 <p>We also encourage you to leave at least two seconds between queries.</p>
-<h2 id="local-cache">Local cache</h2>
-<p>We encourage you to use a local cache and synchronize it every hour or less frequently in accordance with your organization's needs. When you use a local cache you will only be sent changes since the last sync.</p>
-<p>We publish peeringdb-py, which can be used directly or as a reference implementation. <a href="https://github.com/peeringdb/peeringdb-py/">Code is here</a> and <a href="http://peeringdb.github.io/peeringdb-py/">documentation is here</a>.</p>
-<p>Use of an API key with peeringdb-py is highly recommended.</p>
+<h2 id="local-cache-peeringdb-py">Local cache – <code>peeringdb-py</code></h2>
+<p>We encourage you to use local cache <code>peeringdb-py</code> and synchronize it at least once a day, possibly as frequently as once per hour. Please use a random time – <a href="https://peeringdb.github.io/peeringdb-py/cli/#sync">examples</a> – for each sync to avoid pulling from the servers at the same time as others. Synchronizing at least once a day minimizes the chance that you'll hit query limits. This is because <code>peeringdb-py</code> will only be sent changes since the last sync.</p>
+<p><code>peeringdb-py</code>, can be used directly or as a reference implementation. <a href="https://github.com/peeringdb/peeringdb-py/">Code is here</a>, <a href="http://peeringdb.github.io/peeringdb-py/">documentation is here</a>, and <a href="/howto/peeringdb-py">install HOWTO is here</a>.</p>
+<p>We highly recommend using an API key with <code>peeringdb-py</code>.</p>
 <p>If you want to implement a local cache using different tools and would like advice, we are happy to talk. Contact us at <a href="mailto:support@peeringdb.com">support@peeringdb.com</a>.</p>
 <h2 id="tools">Tools</h2>
 <p>Popular tools, including <a href="https://github.com/pierky/arouteserver">arouteserver</a> have been updated to include support for API Keys and to make more efficient queries. <a href="/tools/">We publish</a> a list of tools that we know use PeeringDB. Check the list for tools that you use and upgrade old versions to take advantage of new features and improve everyone’s PeeringDB experience. </p>

index.html

@@ -405,5 +405,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.4.2
-Build Date UTC : 2025-12-13 20:51:21.948879+00:00
+Build Date UTC : 2025-12-18 17:17:41.845236+00:00
 -->