Referral and request refererCopy Anchor Link

A referral value is an organization id or a custom code. A custom code is 8 to 32 lowercase letters and can be set once.

Referral linkCopy Anchor Link

Add the ref query parameter to any URL on www.apibricks.io, www.coinapi.io, or www.finfeedapi.com. It works on the site root and on any other path.

https://www.apibricks.io/?ref=your-ref-code

https://www.coinapi.io/products/market-data-api?ref=your-ref-code

https://www.finfeedapi.com/?ref=your-ref-code

Opening that URL records the visit with the browser device id. An organization created later from that browser, after the visit, is attributed to the code. The sites do not copy ref onto other links. Put it on the URL you share.

API requestCopy Anchor Link

A product API request can send the same organization id or custom code in a referer header.

• Send X-Referrer: your-ref-code, or X-Referer: your-ref-code.
• If both headers are present, X-Referrer is the value that is stored.
• If neither custom header is present, the standard Referer header is used.
• Requests without a referral value are served as usual.
• Any other header value is stored the same way. your-ref-code is the example value.

A successful request is an HTTP 200 response, or HTTP 101 when the WebSocket upgrade completes. In a UTC month, usage attribution applies when the code is on more than 51% of that organization's successful API requests. Exactly 51% does not qualify.

Breaking changes are announced in the CoinAPI changelog and the FinFeedAPI changelog before they ship.