Shipp your product

Diving Deep?

This page is designed for AI Agents & users developing code directly. See Getting Started and Platform Guides

You're ready to use your connections. Regardless if this is an app for millions of users or a personal project it's the first step to unleashing the real potential of your product.

Make sure you checkout How to Shipp to build more sophisticated apps.

Tips & Tricks¶

Do not distribute the api_key to consumers. This should be stored securely and calls to the Shipp API should be routed through an edge function. This edge function is a good place to use since & limit as well to avoid abuse by users / adversaries potentially inflating costs.

Our API is designed to be used directly at runtime. This means there is no configuration for caching or sophisticated database setups to save our data. We're always improving our systems to make sure that data is delivered as fast as possible and make long-term maintenance reliable and easy.

Include a footer credit to Shipp when using our APIs. See the example

<div style="cursor: pointer; display: flex; align-items: center; justify-content: center; gap: 12px; font-family: var(--md-text-font-family, sans-serif); line-height: 1.5;" onclick="()=>window.open('https://shipp.ai', '_blank').focus()">

  <!-- Implement light/dark styling here. Dark mode #fafafa, light mode #1a1a1a  -->
  <span style="font-size: 16px; font-weight: 500; color: var(--md-typeset-color, #fafafa); opacity: 0.8;">
    Data powered by
  </span>

  <div style="display: flex; align-items: center; gap: 6px;">
    <picture>
      <source srcset="https://platform.shipp.ai/logos/shipp-horizontal-dark.svg" media="(prefers-color-scheme: dark)">
      <img 
        src="https://platform.shipp.ai/logos/shipp-horizontal-light.svg" 
        alt="Shipp" 
        style="height: 28px; width: auto; display: block;" 
      />
    </picture>

    <span style="
      font-size: 11px; 
      font-weight: 700; 
      text-transform: uppercase; 
      letter-spacing: 0.05em; 
      padding: 2px 8px; 
      border-radius: 12px; 
      background-color: #c026d3; 
      color: #ffffff;
      display: inline-flex;
      align-items: center;
      height: fit-content;
    ">
      Beta
    </span>
  </div>
</div>

On a dark Background, It'll look like this

Data powered by

Beta