Getting started
Take our API for a spin! Send your first PrimaryBid Connect API request. By following a few steps, you can perform an API call and receive a response in less than 3 minutes. Ready?
Step 1. Get your API keys
Every call to our API must include a pair of API keys comprised of:
- primary-bid-api-subscription,
- primary-bid-api-secret.
To obtain your credentials, please reach out to your PrimaryBid Solutions Engineer. We’ll also need a list of your IP addresses so we can allowlist them (for more details, see the Authentication page).
Step 2. Make your first request
Now let’s assume you’d like to see all current PrimaryBid offer
. This means you have to call our Get all offers endpoint. Go to your favourite Command Line Interface (e.g. cURL), write and send the following request:curl --request GET \
--url https://stagingapi.primarybid.com/offer \
--header 'accept: application/json' \
--header 'primary-bid-api-secret: YourApiSubscription' \
--header 'primary-bid-api-subscription: YourApiSecret'
For requests in another language, use the right-hand pane on the Get all offers page. Select the language, fill in the authentication fields, and select a server from the Base URL dropdown. Copy-paste the request into your chosen tool.
Step 3. Evaluate the response
If your request is successful, you receive a 200 response that lists all live offers in a JSON format.
[
{
"id": "649c013cff4058787b85a61b",
"offerType": "primary_placing",
"offerSubType": "company_placing",
"details": {
"status": "open_for_subscription",
"countryCode": "GB",
"type": "follow_on",
"subType": "primary",
"estTargetRaise": null,
"pressReleaseLink": "",
"membershipRequired": "no",
"offeringDocuments": [
{
"title": "This is my test admission document",
"documentUrl": "https://devoffer-assets.primarybid.com/e23_Factsheet.pdf"
}
]
},
"textProperties": {
"legalDisclaimer": "Please read our Risk Warning [/risk-warning] before subscribing.",
"title": "",
"specialInstruction": "These are my test instructions",
"companyAnnouncements": "This is my test company announcement",
"priceless": "",
"useOfProceeds": "This is my test use of proceeds",
"offerDiscount": "This is my test discount footnote",
"restriction": "These are my test conditions"
},
"issuer": {
"id": "6400ce97821dacc8b765c405",
"businessDescriptionText": "Here's another test offer",
"companyName": "Another Test Offer",
"exchangeMic": "XLON",
"ticker": "ATO",
"sector": "Automobiles & Parts",
"securityIdentifier": "123456789",
"fttRequired": false,
"sellerName": "",
"issuerType": "company"
},
"dates": {
"offerStartDateTime": "2023-06-28T09:53:29.295Z",
"offerEndDateTime": "2023-07-03T08:00:00.000Z",
"lastModifiedOn": "2023-06-28T09:53:29.295Z",
"admissionDateTime": "2023-06-28T06:00:00.000Z"
},
"pricingAndOrderLimits": {
"acceptedCurrency": "GBP",
"priceType": "fixed",
"offerPrice": 1,
"currency": "GBP",
"hardMaxLimit": 999999,
"hardMinLimit": 100,
"discount": 5,
"discountTo": null,
"discountFrom": null
}
},
{
"id": "64959ff382e3686f2d69e3ba",
"offerType": "primary_placing",
"offerSubType": "company_placing",
"details": {
"status": "open_for_subscription",
"countryCode": "GB",
"type": "follow_on",
"subType": "primary",
"estTargetRaise": null,
"pressReleaseLink": "",
"membershipRequired": "no",
"offeringDocuments": []
},
"textProperties": {
"legalDisclaimer": "Please read our Risk Warning [/risk-warning] before subscribing.",
"title": "",
"specialInstruction": "Instructions\n",
"companyAnnouncements": "Company Announcement\n",
"priceless": "The price per Retail Offer Share will be determined at the end of the Bookbuild",
"useOfProceeds": "Use of Proceeds\n",
"offerDiscount": null,
"restriction": "Conditions"
},
"issuer": {
"id": "64959fd5f3b52bde390f3443",
"businessDescriptionText": "issuer for on-behalf subs",
"companyName": "#weekly on-behalf subs",
"exchangeMic": "XLON",
"ticker": "OBS",
"sector": "Automobiles & Parts",
"fttRequired": false,
"sellerName": "",
"issuerType": "company"
},
"dates": {
"offerStartDateTime": "2023-06-23T13:38:10.723Z",
"offerEndDateTime": "2023-06-24T13:36:00.000Z",
"offerEarlyClose": "2023-06-23T13:50:20.691Z",
"lastModifiedOn": "2023-07-11T10:26:13.151Z",
"admissionDateTime": "2023-06-23T13:51:00.000Z"
},
"pricingAndOrderLimits": {
"acceptedCurrency": "GBP",
"priceType": "no_price",
"offerPrice": 0.01,
"currency": "GBP",
"hardMaxLimit": 999999,
"hardMinLimit": 0.01,
"discount": null,
"discountTo": null,
"discountFrom": null
}
},
{
"id": "6487793dc63a7056f45c00a1",
"offerType": "primary_placing",
"offerSubType": "company_placing",
"details": {
"status": "open_for_subscription",
"countryCode": "GB",
"type": "follow_on",
"subType": "primary",
"estTargetRaise": null,
"pressReleaseLink": "",
"membershipRequired": "no",
"offeringDocuments": []
},
"textProperties": {
"legalDisclaimer": "Please read our Risk Warning [/risk-warning] before subscribing.",
"title": "",
"specialInstruction": "Instructions",
"companyAnnouncements": "Company Announcement",
"priceless": "",
"useOfProceeds": "Use of Proceeds",
"offerDiscount": null,
"restriction": "Conditions"
},
"issuer": {
"id": "6387486a48ec8c9874bc5001",
"businessDescriptionText": "for weekly testing ecp subs",
"companyName": "#weekly ECP Sub Me",
"exchangeMic": "XLON",
"ticker": "ESM",
"sector": "Automobiles & Parts",
"fttRequired": false,
"sellerName": "",
"issuerType": "company"
},
"dates": {
"offerStartDateTime": "2023-06-12T21:24:56.373Z",
"offerEndDateTime": "2023-06-13T19:59:00.000Z",
"offerEarlyClose": "2023-06-13T09:20:31.665Z",
"lastModifiedOn": "2023-07-11T10:23:47.332Z",
"admissionDateTime": "2023-06-13T09:21:00.000Z"
},
"pricingAndOrderLimits": {
"acceptedCurrency": "GBP",
"priceType": "fixed",
"offerPrice": 0.01,
"currency": "GBP",
"hardMaxLimit": 999999,
"hardMinLimit": 1,
"discount": 1,
"discountTo": null,
"discountFrom": null
}
}
]
Congratulations! You have just completed your first PrimaryBid Connect API
call.