Postman Collection

7 min

A ready-to-run Postman collection covering every endpoint in the EquiDeFi API reference. Import it, add your API key, and you can exercise the full offering and investment surface without writing any code.

Prerequisite — You need an API key and the offering ID it is scoped to. See Getting Started to create one.

Download

EquiDeFi-Open-API.postman_collection.json

The collection targets the Demo environment by default, so you can run it end to end without touching production data.

Import and configure

In Postman, choose Import and select the downloaded .json file.

Open the collection, go to the Variables tab, and fill in the values below.

Save. Every request inherits Authorization: Bearer {{apiKey}} from the collection, so there is nothing to set per request.

Variable	Required	Description
baseUrl	Yes	https://demo.equidefi.io/api/v1 for demo, https://equidefi.io/api/v1 for production. Defaults to demo.
apiKey	Yes	The key issued in the issuer portal. Sent as a bearer token.
offeringId	No	The offering your key is scoped to. Any other ID returns 403.
investmentId	No	Filled in automatically by Retrieve Offering Investments, or set it yourself.

Use a Postman environment for your key. Store apiKey as a secret variable in a Postman environment rather than in the collection itself. Collection variables travel with the file when it is exported or shared to a team workspace; environment secrets do not.

What's included

Requests are grouped into two folders. Each one ships with assertions, so a green run confirms the response shape as well as the status code.

Offerings

Request	Endpoint
Retrieve an Offering	GET /offerings/:id
Retrieve Offering Investments	GET /offerings/:id/investments

Retrieve Offering Investments has page and size pre-filled, plus disabled create_date[gte|lte] and modify_date[gte|lte] parameters you can enable to test date filtering. Run it before the Investments folder — it saves the first result to investmentId so the remaining requests work unattended.

Investments

Request	Endpoint
Retrieve an Investment	GET /investments/:id
Retrieve Investment Status	GET /investments/:id/status
Retrieve Investment Events	GET /investments/:id/events

Retrieve Investment Events carries the same disabled create_date[gte|lte] parameters. The filter applies to the events themselves, not to the investment.

Responses contain investor PII. Postman saves response bodies in your request history and, in a team workspace, may sync them. Prefer the demo environment while you are integrating, and avoid sharing captured production responses. See Compliance for your obligations around handling investor data.

Troubleshooting

Status	Cause	Fix
401	Missing, malformed, or revoked key.	Confirm apiKey is set and the header reads Bearer <key>. Rotate the key if it may be compromised.
403	The offeringId does not match the offering your key was issued against.	Use the correct offering ID.
404	The investment does not exist, or belongs to another offering.	Re-run Retrieve Offering Investments to get a valid ID.
429	Over 120 requests/min for this key.	Wait for the window named in Retry-After. See Rate Limiting.