Quick start

Make your first Pipispy API request using a key from your Open Platform dashboard.

1. Get an API key

Open your dashboard and sign in or create an account. Review your plan and available credits, then copy your API key.

Keep your key on your server. Do not include it in public repositories, browser code, or mobile applications.

2. Choose an endpoint

Start with the Adspy List API. It returns ad data using filters and pagination.

• Request method: POST
• Request URL: https://www.pipispy.com/open-api/v1/data
• Endpoint URI: /v3/api/open/adspy/list
• Content type: application/json

The request body contains your key, the endpoint uri, and a params object. Use current_page: 1 and page_size: 10 for a first request. A successful data query consumes credits according to the endpoint's usage notes.

3. Handle the response

Check the HTTP status and the response body's code and message. A body with code: 200 represents a successful result for this endpoint. Process the data field according to the endpoint response schema.

An HTTP success alone does not guarantee a successful API operation. Handle validation, authentication, and quota errors in your application.

4. Build your workflow

Use the endpoint's documented pagination and filters. Other APIs may have different required parameters or use a separate gateway, such as /open-api/v1/monitor/data for monitoring or multipart uploads for image search.

Read Authentication and Usage & errors before integrating. The examples below run on your server; Python requires the requests package, and JavaScript requires Node.js with built-in fetch support.